CMS 3D CMS Logo

Classes | Enumerations | Functions
simBeamSpotHLLHCPI Namespace Reference

Classes

class  DisplayParameters
 
class  DisplayParametersDiff
 
class  SimBSHLLHCParamsHelper
 

Enumerations

enum  parameters {
  meanX = 1, meanY = 2, meanZ = 3, eProton = 4,
  crabFrequency = 5, rf800 = 6, crossingAngle = 7, crabbingAngleCrossing = 8,
  crabbingAngleSeparation = 9, betaCrossingPlane = 10, betaSeparationPlane = 11, horizontalEmittance = 12,
  verticalEmittance = 13, bunchLenght = 14, timeOffset = 15, END_OF_TYPES = 16
}
 

Functions

std::string getStringFromParamEnum (const parameters &parameter, const bool addUnits=false)
 

Enumeration Type Documentation

◆ parameters

Enumerator
meanX 
meanY 
meanZ 
eProton 
crabFrequency 
rf800 
crossingAngle 
crabbingAngleCrossing 
crabbingAngleSeparation 
betaCrossingPlane 
betaSeparationPlane 
horizontalEmittance 
verticalEmittance 
bunchLenght 
timeOffset 
END_OF_TYPES 

Definition at line 1078 of file BeamSpotPayloadInspectorHelper.h.

1078  {
1079  meanX = 1, // 1 - Positions
1080  meanY = 2, // 2
1081  meanZ = 3, // 3
1082  eProton = 4, // 4 - LHC config
1083  crabFrequency = 5, // 5
1084  rf800 = 6, // 6
1085  crossingAngle = 7, // 7 - Crossing and crabbing angles
1086  crabbingAngleCrossing = 8, // 8
1087  crabbingAngleSeparation = 9, // 9
1088  betaCrossingPlane = 10, // 10 - Betastar and emittance
1089  betaSeparationPlane = 11, // 11
1090  horizontalEmittance = 12, // 12
1091  verticalEmittance = 13, // 13
1092  bunchLenght = 14, // 14 - Additional parameters
1093  timeOffset = 15, // 15
1094  END_OF_TYPES = 16,
1095  };

Function Documentation

◆ getStringFromParamEnum()

std::string simBeamSpotHLLHCPI::getStringFromParamEnum ( const parameters parameter,
const bool  addUnits = false 
)
inline

Definition at line 1098 of file BeamSpotPayloadInspectorHelper.h.

References betaCrossingPlane, betaSeparationPlane, bunchLenght, crabbingAngleCrossing, crabbingAngleSeparation, crabFrequency, crossingAngle, eProton, horizontalEmittance, meanX, meanY, meanZ, rf800, timeOffset, and verticalEmittance.

Referenced by simBeamSpotHLLHCPI::DisplayParameters< PayloadType >::fill(), simBeamSpotHLLHCPI::DisplayParametersDiff< PayloadType, nIOVs, ntags >::fill(), and simBeamSpotHLLHCPI::SimBSHLLHCParamsHelper< PayloadType >::printDebug().

1098  {
1099  switch (parameter) {
1100  case meanX:
1101  return (addUnits ? "MeanX [cm]" : "meanX");
1102  case meanY:
1103  return (addUnits ? "MeanY [cm]" : "meanY");
1104  case meanZ:
1105  return (addUnits ? "MeanZ [cm]" : "meanZ");
1106  case eProton:
1107  return (addUnits ? "E_{proton} [GeV]" : "eProton");
1108  case crabFrequency:
1109  return (addUnits ? "Crab freq. [MHz]" : "crabFrequency");
1110  case rf800:
1111  return (addUnits ? "RF800" : "rf800");
1112  case crossingAngle:
1113  return (addUnits ? "x-ing angle [#murad]" : "crossingAngle");
1114  case crabbingAngleCrossing:
1115  return (addUnits ? "Crab x-ing angle [#murad]" : "crabbingAngleCrossing");
1117  return (addUnits ? "Crab sep. angle [#murad]" : "crabbingAngleSeparation");
1118  case betaCrossingPlane:
1119  return (addUnits ? "#beta x-ing plane [m]" : "betaCrossingPlane");
1120  case betaSeparationPlane:
1121  return (addUnits ? "#beta sep. plane [m]" : "betaSeparationPlane");
1122  case horizontalEmittance:
1123  return (addUnits ? "#epsilon_{horizontal} [mm]" : "horizontalEmittance");
1124  case verticalEmittance:
1125  return (addUnits ? "#epsilon_{vertical} [mm]" : "verticalEmittance");
1126  case bunchLenght:
1127  return (addUnits ? "Bunch lenght [m]" : "bunchLenght");
1128  case timeOffset:
1129  return (addUnits ? "TimeOffset [ns]" : "TimeOffset");
1130  default:
1131  return "should never be here";
1132  }
1133  }