Geant4-11
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
G4GlobalMagFieldMessenger Class Reference

#include <G4GlobalMagFieldMessenger.hh>

Inheritance diagram for G4GlobalMagFieldMessenger:
G4UImessenger

Public Member Functions

G4bool CommandsShouldBeInMaster () const
 
 G4GlobalMagFieldMessenger (const G4ThreeVector &value=G4ThreeVector())
 
virtual G4String GetCurrentValue (G4UIcommand *command)
 
G4ThreeVector GetFieldValue () const
 
G4int GetVerboseLevel () const
 
G4bool operator!= (const G4UImessenger &messenger) const
 
G4bool operator== (const G4UImessenger &messenger) const
 
void SetFieldValue (const G4ThreeVector &value)
 
virtual void SetNewValue (G4UIcommand *, G4String)
 
void SetVerboseLevel (G4int verboseLevel)
 
virtual ~G4GlobalMagFieldMessenger ()
 

Protected Member Functions

void AddUIcommand (G4UIcommand *newCommand)
 
G4String BtoS (G4bool b)
 
template<typename T >
T * CreateCommand (const G4String &cname, const G4String &dsc)
 
void CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
 
G4String DtoS (G4double a)
 
G4String ItoS (G4int i)
 
G4bool StoB (G4String s)
 
G4double StoD (G4String s)
 
G4int StoI (G4String s)
 
G4long StoL (G4String s)
 

Protected Attributes

G4UIdirectorybaseDir = nullptr
 
G4String baseDirName = ""
 
G4bool commandsShouldBeInMaster = false
 

Private Member Functions

void SetField (const G4ThreeVector &value, const G4String &inFunction)
 

Private Attributes

G4UIdirectoryfDirectory = nullptr
 
G4UniformMagFieldfMagField = nullptr
 
G4UIcmdWith3VectorAndUnitfSetValueCmd = nullptr
 
G4UIcmdWithAnIntegerfSetVerboseCmd = nullptr
 
G4int fVerboseLevel = 0
 

Detailed Description

Definition at line 54 of file G4GlobalMagFieldMessenger.hh.

Constructor & Destructor Documentation

◆ G4GlobalMagFieldMessenger()

G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger ( const G4ThreeVector value = G4ThreeVector())

Definition at line 45 of file G4GlobalMagFieldMessenger.cc.

47{
48 fDirectory = new G4UIdirectory("/globalField/");
49 fDirectory->SetGuidance("Global uniform magnetic field UI commands");
50
51 fSetValueCmd = new G4UIcmdWith3VectorAndUnit("/globalField/setValue",this);
52 fSetValueCmd->SetGuidance("Set uniform magnetic field value.");
53 fSetValueCmd->SetParameterName("Bx", "By", "By", false);
54 fSetValueCmd->SetUnitCategory("Magnetic flux density");
56
57 fSetVerboseCmd = new G4UIcmdWithAnInteger("/globalField/verbose",this);
58 fSetVerboseCmd->SetGuidance("Set verbose level: ");
59 fSetVerboseCmd->SetGuidance(" 0: no output");
60 fSetVerboseCmd->SetGuidance(" 1: printing new field value");
61 fSetVerboseCmd->SetParameterName("globalFieldVerbose", false);
62 fSetVerboseCmd->SetRange("globalFieldVerbose>=0");
64
65 // Create field
66 fMagField = new G4UniformMagField(value);
67
68 // Set field value (the field is not activated if value is zero)
69 SetField(value, "G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger");
70}
@ G4State_Idle
@ G4State_PreInit
void SetField(const G4ThreeVector &value, const G4String &inFunction)
G4UIcmdWith3VectorAndUnit * fSetValueCmd
G4UIcmdWithAnInteger * fSetVerboseCmd
void SetParameterName(const char *theNameX, const char *theNameY, const char *theNameZ, G4bool omittable, G4bool currentAsDefault=false)
void SetUnitCategory(const char *unitCategory)
void SetParameterName(const char *theName, G4bool omittable, G4bool currentAsDefault=false)
void SetGuidance(const char *aGuidance)
Definition: G4UIcommand.hh:156
void SetRange(const char *rs)
Definition: G4UIcommand.hh:120
void AvailableForStates(G4ApplicationState s1)
Definition: G4UIcommand.cc:288

References G4UIcommand::AvailableForStates(), fDirectory, fMagField, fSetValueCmd, fSetVerboseCmd, G4State_Idle, G4State_PreInit, SetField(), G4UIcommand::SetGuidance(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetParameterName(), G4UIcommand::SetRange(), and G4UIcmdWith3VectorAndUnit::SetUnitCategory().

◆ ~G4GlobalMagFieldMessenger()

G4GlobalMagFieldMessenger::~G4GlobalMagFieldMessenger ( )
virtual

Definition at line 74 of file G4GlobalMagFieldMessenger.cc.

75{
76 delete fMagField;
77 delete fSetValueCmd;
78 delete fSetVerboseCmd;
79 delete fDirectory;
80}

References fDirectory, fMagField, fSetValueCmd, and fSetVerboseCmd.

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand newCommand)
protectedinherited

Definition at line 149 of file G4UImessenger.cc.

150{
151 G4cerr << "Warning : Old style definition of G4UIcommand <"
152 << newCommand->GetCommandPath() << ">." << G4endl;
153}
G4GLOB_DLL std::ostream G4cerr
#define G4endl
Definition: G4ios.hh:57
const G4String & GetCommandPath() const
Definition: G4UIcommand.hh:136

References G4cerr, G4endl, and G4UIcommand::GetCommandPath().

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool  b)
protectedinherited

Definition at line 98 of file G4UImessenger.cc.

99{
100 G4String vl = "0";
101 if(b)
102 vl = "true";
103 return vl;
104}

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const
inlineinherited

Definition at line 77 of file G4UImessenger.hh.

78 {
80 }
G4bool commandsShouldBeInMaster

References G4UImessenger::commandsShouldBeInMaster.

Referenced by G4UIcommand::G4UIcommandCommonConstructorCode().

◆ CreateCommand()

template<typename T >
T * G4UImessenger::CreateCommand ( const G4String cname,
const G4String dsc 
)
protectedinherited

Definition at line 110 of file G4UImessenger.hh.

111{
112 G4String path;
113 if(cname[0] != '/')
114 {
115 path = baseDirName + cname;
116 if(path[0] != '/')
117 path = "/" + path;
118 }
119
120 T* command = new T(path.c_str(), this);
121 command->SetGuidance(dsc.c_str());
122
123 return command;
124}
G4String baseDirName

References G4UImessenger::baseDirName.

◆ CreateDirectory()

void G4UImessenger::CreateDirectory ( const G4String path,
const G4String dsc,
G4bool  commandsToBeBroadcasted = true 
)
protectedinherited

Definition at line 156 of file G4UImessenger.cc.

158{
160
161 G4String fullpath = path;
162 if(fullpath.back() != '/')
163 fullpath.append("/");
164
165 G4UIcommandTree* tree = ui->GetTree()->FindCommandTree(fullpath.c_str());
166 if(tree != nullptr)
167 {
168 baseDirName = tree->GetPathName();
169 }
170 else
171 {
172 baseDir = new G4UIdirectory(fullpath.c_str(), commandsToBeBroadcasted);
173 baseDirName = fullpath;
174 baseDir->SetGuidance(dsc.c_str());
175 }
176}
const G4String & GetPathName() const
G4UIcommandTree * FindCommandTree(const char *commandPath)
G4UIcommandTree * GetTree() const
Definition: G4UImanager.hh:186
static G4UImanager * GetUIpointer()
Definition: G4UImanager.cc:77
G4UIdirectory * baseDir

References G4UImessenger::baseDir, G4UImessenger::baseDirName, G4UIcommandTree::FindCommandTree(), G4UIcommandTree::GetPathName(), G4UImanager::GetTree(), G4UImanager::GetUIpointer(), and G4UIcommand::SetGuidance().

Referenced by G4MoleculeShootMessenger::G4MoleculeShootMessenger(), and G4UImessenger::G4UImessenger().

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double  a)
protectedinherited

Definition at line 90 of file G4UImessenger.cc.

91{
92 std::ostringstream os;
93 os << a;
94 return G4String(os.str());
95}

Referenced by G4ScoreQuantityMessenger::FilterCommands(), and G4UIcontrolMessenger::SetNewValue().

◆ GetCurrentValue()

G4String G4UImessenger::GetCurrentValue ( G4UIcommand command)
virtualinherited

Reimplemented in G4ScoreQuantityMessenger, G4VisCommandModelCreate< Factory >, G4VisCommandListManagerList< Manager >, G4VisCommandListManagerSelect< Manager >, G4VisCommandManagerMode< Manager >, G4ToolsAnalysisMessenger, G4ScoringMessenger, G4EvManMessenger, G4GeneralParticleSourceMessenger, G4ParticleGunMessenger, G4GeometryMessenger, G4GenericMessenger, G4UIcontrolMessenger, GFlashShowerModelMessenger, G4DecayTableMessenger, G4ParticleMessenger, G4ParticlePropertyMessenger, G4tgrMessenger, G4PersistencyCenterMessenger, G4ProductionCutsTableMessenger, G4SchedulerMessenger, G4VITSteppingVerbose, G4MoleculeShootMessenger, G4MoleculeGunMessenger, G4ProcessManagerMessenger, G4ProcessTableMessenger, G4MatScanMessenger, G4RunMessenger, G4UserPhysicsListMessenger, G4TrackingMessenger, G4GMocrenMessenger, G4HepRepMessenger, G4VisCommandAbortReviewKeptEvents, G4VisCommandDrawOnlyToBeKeptEvents, G4VisCommandEnable, G4VisCommandList, G4VisCommandReviewKeptEvents, G4VisCommandVerbose, G4VisCommandGeometryList, G4VisCommandGeometryRestore, G4VisCommandGeometrySetColour, G4VisCommandGeometrySetDaughtersInvisible, G4VisCommandGeometrySetForceAuxEdgeVisible, G4VisCommandGeometrySetForceCloud, G4VisCommandGeometrySetForceSolid, G4VisCommandGeometrySetForceLineSegmentsPerCircle, G4VisCommandGeometrySetForceWireframe, G4VisCommandGeometrySetLineStyle, G4VisCommandGeometrySetLineWidth, G4VisCommandGeometrySetVisibility, G4VisCommandSceneActivateModel, G4VisCommandSceneCreate, G4VisCommandSceneEndOfEventAction, G4VisCommandSceneEndOfRunAction, G4VisCommandSceneList, G4VisCommandSceneNotifyHandlers, G4VisCommandSceneRemoveModel, G4VisCommandSceneSelect, G4VisCommandSceneShowExtents, G4VisCommandSceneAddArrow, G4VisCommandSceneAddArrow2D, G4VisCommandSceneAddAxes, G4VisCommandSceneAddDate, G4VisCommandSceneAddDigis, G4VisCommandSceneAddEventID, G4VisCommandSceneAddExtent, G4VisCommandSceneAddElectricField, G4VisCommandSceneAddFrame, G4VisCommandSceneAddGPS, G4VisCommandSceneAddGhosts, G4VisCommandSceneAddHits, G4VisCommandSceneAddLine, G4VisCommandSceneAddLine2D, G4VisCommandSceneAddLocalAxes, G4VisCommandSceneAddLogicalVolume, G4VisCommandSceneAddLogo, G4VisCommandSceneAddLogo2D, G4VisCommandSceneAddMagneticField, G4VisCommandSceneAddPSHits, G4VisCommandSceneAddScale, G4VisCommandSceneAddText, G4VisCommandSceneAddText2D, G4VisCommandSceneAddTrajectories, G4VisCommandSceneAddUserAction, G4VisCommandSceneAddVolume, G4VisCommandSceneAddPlotter, G4VisCommandSceneHandlerAttach, G4VisCommandSceneHandlerCreate, G4VisCommandSceneHandlerList, G4VisCommandSceneHandlerSelect, G4VisCommandSetArrow3DLineSegmentsPerCircle, G4VisCommandSetColour, G4VisCommandSetExtentForField, G4VisCommandSetLineWidth, G4VisCommandSetTextColour, G4VisCommandSetTextLayout, G4VisCommandSetTextSize, G4VisCommandSetTouchable, G4VisCommandSetVolumeForField, G4VisCommandsTouchable, G4VisCommandsTouchableSet, G4VisCommandViewerAddCutawayPlane, G4VisCommandViewerCentreOn, G4VisCommandViewerChangeCutawayPlane, G4VisCommandViewerClear, G4VisCommandViewerClearCutawayPlanes, G4VisCommandViewerClearTransients, G4VisCommandViewerClearVisAttributesModifiers, G4VisCommandViewerClone, G4VisCommandViewerColourByDensity, G4VisCommandViewerCopyViewFrom, G4VisCommandViewerCreate, G4VisCommandViewerDolly, G4VisCommandViewerFlush, G4VisCommandViewerInterpolate, G4VisCommandViewerList, G4VisCommandViewerPan, G4VisCommandViewerReset, G4VisCommandViewerRefresh, G4VisCommandViewerRebuild, G4VisCommandViewerSave, G4VisCommandViewerScale, G4VisCommandViewerSelect, G4VisCommandViewerUpdate, G4VisCommandViewerZoom, G4VisCommandViewerDefaultHiddenEdge, G4VisCommandViewerDefaultStyle, G4VisCommandsViewerSet, G4VModelCommand< T >, G4VModelCommand< M >, G4RTMessenger, G4ASCIITreeMessenger, G4VtkMessenger, G4PolarizationMessenger, and G4DNAChemistryManager.

Definition at line 58 of file G4UImessenger.cc.

59{
60 G4String nullString;
61 return nullString;
62}

Referenced by G4UIcommand::DoIt(), and G4UIcommand::GetCurrentValue().

◆ GetFieldValue()

G4ThreeVector G4GlobalMagFieldMessenger::GetFieldValue ( ) const

Definition at line 141 of file G4GlobalMagFieldMessenger.cc.

142{
144
145 return G4ThreeVector();
146}
CLHEP::Hep3Vector G4ThreeVector
G4ThreeVector GetConstantFieldValue() const

References fMagField, and G4UniformMagField::GetConstantFieldValue().

◆ GetVerboseLevel()

G4int G4GlobalMagFieldMessenger::GetVerboseLevel ( ) const
inline

Definition at line 86 of file G4GlobalMagFieldMessenger.hh.

References fVerboseLevel.

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int  i)
protectedinherited

Definition at line 82 of file G4UImessenger.cc.

83{
84 std::ostringstream os;
85 os << i;
86 return G4String(os.str());
87}

Referenced by G4GenericMessenger::DeclareMethod(), and G4ParticleGunMessenger::GetCurrentValue().

◆ operator!=()

G4bool G4UImessenger::operator!= ( const G4UImessenger messenger) const
inherited

Definition at line 76 of file G4UImessenger.cc.

77{
78 return this != &messenger;
79}

◆ operator==()

G4bool G4UImessenger::operator== ( const G4UImessenger messenger) const
inherited

Definition at line 70 of file G4UImessenger.cc.

71{
72 return this == &messenger;
73}

◆ SetField()

void G4GlobalMagFieldMessenger::SetField ( const G4ThreeVector value,
const G4String inFunction 
)
private

Definition at line 84 of file G4GlobalMagFieldMessenger.cc.

86{
87 // Get field manager (or create it if it does not yet exist)
88 G4FieldManager* fieldManager
90
91 // Inactivate field if its value is zero
92 if ( value == G4ThreeVector() )
93 {
94 fieldManager->SetDetectorField(0);
95 fieldManager->CreateChordFinder(0);
96
97 if ( fVerboseLevel > 0 )
98 {
99 G4cout << "Magnetic field is inactive, fieldValue = (0,0,0)." << G4endl;
100 }
101 }
102 else
103 {
104 fMagField->SetFieldValue(value);
105 fieldManager->SetDetectorField(fMagField);
106 fieldManager->CreateChordFinder(fMagField);
107
108 if ( fVerboseLevel > 0 )
109 {
110 G4cout << "Magnetic field is active, fieldValue = ("
111 << G4BestUnit(value, "Magnetic flux density")
112 << ")." << G4endl;
113 }
114 }
115}
#define G4BestUnit(a, b)
G4GLOB_DLL std::ostream G4cout
G4bool SetDetectorField(G4Field *detectorField, G4int failMode=0)
void CreateChordFinder(G4MagneticField *detectorMagField)
static G4TransportationManager * GetTransportationManager()
G4FieldManager * GetFieldManager() const
void SetFieldValue(const G4ThreeVector &newFieldValue)

References G4FieldManager::CreateChordFinder(), fMagField, fVerboseLevel, G4BestUnit, G4cout, G4endl, G4TransportationManager::GetFieldManager(), G4TransportationManager::GetTransportationManager(), G4FieldManager::SetDetectorField(), and G4UniformMagField::SetFieldValue().

Referenced by G4GlobalMagFieldMessenger(), SetFieldValue(), and SetNewValue().

◆ SetFieldValue()

void G4GlobalMagFieldMessenger::SetFieldValue ( const G4ThreeVector value)

Definition at line 134 of file G4GlobalMagFieldMessenger.cc.

135{
136 SetField(value, "G4GlobalMagFieldMessenger::SetFieldValue");
137}

References SetField().

◆ SetNewValue()

void G4GlobalMagFieldMessenger::SetNewValue ( G4UIcommand command,
G4String  newValue 
)
virtual

Reimplemented from G4UImessenger.

Definition at line 119 of file G4GlobalMagFieldMessenger.cc.

120{
121 if ( command == fSetValueCmd )
122 {
124 "G4GlobalMagFieldMessenger::SetNewValue");
125 }
126 else if ( command == fSetVerboseCmd )
127 {
129 }
130}
void SetVerboseLevel(G4int verboseLevel)
static G4ThreeVector GetNew3VectorValue(const char *paramString)
static G4int GetNewIntValue(const char *paramString)

References fSetValueCmd, fSetVerboseCmd, G4UIcmdWith3VectorAndUnit::GetNew3VectorValue(), G4UIcmdWithAnInteger::GetNewIntValue(), SetField(), and SetVerboseLevel().

◆ SetVerboseLevel()

void G4GlobalMagFieldMessenger::SetVerboseLevel ( G4int  verboseLevel)
inline

Definition at line 83 of file G4GlobalMagFieldMessenger.hh.

84{ fVerboseLevel = verboseLevel; }

References fVerboseLevel.

Referenced by SetNewValue().

◆ StoB()

G4bool G4UImessenger::StoB ( G4String  s)
protectedinherited

Definition at line 137 of file G4UImessenger.cc.

138{
140 G4bool vl = false;
141 if(v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE")
142 {
143 vl = true;
144 }
145 return vl;
146}
bool G4bool
Definition: G4Types.hh:86
G4String to_upper_copy(G4String str)
Return uppercase copy of string.

References G4StrUtil::to_upper_copy().

Referenced by G4LocalThreadCoutMessenger::SetNewValue(), G4CascadeParamMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoD()

G4double G4UImessenger::StoD ( G4String  s)
protectedinherited

◆ StoI()

G4int G4UImessenger::StoI ( G4String  s)
protectedinherited

◆ StoL()

G4long G4UImessenger::StoL ( G4String  s)
protectedinherited

Definition at line 117 of file G4UImessenger.cc.

118{
119 G4long vl;
120 const char* t = str;
121 std::istringstream is(t);
122 is >> vl;
123 return vl;
124}
long G4long
Definition: G4Types.hh:87

Referenced by G4RunMessenger::SetNewValue().

Field Documentation

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr
protectedinherited

◆ baseDirName

G4String G4UImessenger::baseDirName = ""
protectedinherited

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false
protectedinherited

◆ fDirectory

G4UIdirectory* G4GlobalMagFieldMessenger::fDirectory = nullptr
private

◆ fMagField

G4UniformMagField* G4GlobalMagFieldMessenger::fMagField = nullptr
private

◆ fSetValueCmd

G4UIcmdWith3VectorAndUnit* G4GlobalMagFieldMessenger::fSetValueCmd = nullptr
private

◆ fSetVerboseCmd

G4UIcmdWithAnInteger* G4GlobalMagFieldMessenger::fSetVerboseCmd = nullptr
private

◆ fVerboseLevel

G4int G4GlobalMagFieldMessenger::fVerboseLevel = 0
private

Definition at line 74 of file G4GlobalMagFieldMessenger.hh.

Referenced by GetVerboseLevel(), SetField(), and SetVerboseLevel().


The documentation for this class was generated from the following files: