Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
G4FieldSetupMessenger Class Reference

G4FieldSetupMessenger is a messenger class that defines commands for G4FieldSetup. More...

#include <G4FieldSetupMessenger.hh>

Inheritance diagram for G4FieldSetupMessenger:

Public Member Functions

 G4FieldSetupMessenger (G4FieldSetup *fieldSetup)
 ~G4FieldSetupMessenger () override
 G4FieldSetupMessenger ()=delete
 G4FieldSetupMessenger (const G4FieldSetupMessenger &)=delete
G4FieldSetupMessengeroperator= (const G4FieldSetupMessenger &)=delete
void SetNewValue (G4UIcommand *command, G4String newValues) override
Public Member Functions inherited from G4UImessenger
 G4UImessenger ()=default
 G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual ~G4UImessenger ()
virtual G4String GetCurrentValue (G4UIcommand *command)
G4bool CommandsShouldBeInMaster () const

Additional Inherited Members

Protected Member Functions inherited from G4UImessenger
G4String ItoS (G4int i)
G4String LtoS (G4long l)
G4String DtoS (G4double a)
G4String BtoS (G4bool b)
G4int StoI (const G4String &s)
G4long StoL (const G4String &s)
G4double StoD (const G4String &s)
G4bool StoB (const G4String &s)
void AddUIcommand (G4UIcommand *newCommand)
void CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T>
T * CreateCommand (const G4String &cname, const G4String &dsc)
Protected Attributes inherited from G4UImessenger
G4UIdirectorybaseDir = nullptr
G4String baseDirName = ""
G4bool commandsShouldBeInMaster = false

Detailed Description

G4FieldSetupMessenger is a messenger class that defines commands for G4FieldSetup.

Definition at line 55 of file G4FieldSetupMessenger.hh.

Constructor & Destructor Documentation

◆ G4FieldSetupMessenger() [1/3]

G4FieldSetupMessenger::G4FieldSetupMessenger ( G4FieldSetup * fieldSetup)

Standard Constructor and Destructor.

Definition at line 40 of file G4FieldSetupMessenger.cc.

41 : fFieldSetup(fieldSetup)
42{
43 // Standard constructor
44
45 G4String directoryName = "/field/";
46 if (fFieldSetup->GetLogicalVolume() != nullptr)
47 {
48 directoryName.append(fFieldSetup->GetLogicalVolume()->GetName());
49 directoryName.append("/");
50 }
51
52 G4String commandName = std::move(directoryName);
53 commandName.append("update");
54 fUpdateCmd = new G4UIcmdWithoutParameter(commandName, this);
55 fUpdateCmd->SetGuidance("Update field setup.");
56 fUpdateCmd->AvailableForStates(G4State_PreInit, G4State_Init, G4State_Idle);
57}
@ G4State_Init
@ G4State_Idle
@ G4State_PreInit

Referenced by G4FieldSetupMessenger(), and operator=().

◆ ~G4FieldSetupMessenger()

G4FieldSetupMessenger::~G4FieldSetupMessenger ( )
override

Definition at line 60 of file G4FieldSetupMessenger.cc.

61{
62 // Destructor
63
64 delete fUpdateCmd;
65}

◆ G4FieldSetupMessenger() [2/3]

G4FieldSetupMessenger::G4FieldSetupMessenger ( )
delete

Default constructor, copy constructor and assignment operator not allowed.

◆ G4FieldSetupMessenger() [3/3]

G4FieldSetupMessenger::G4FieldSetupMessenger ( const G4FieldSetupMessenger & )
delete

Member Function Documentation

◆ operator=()

G4FieldSetupMessenger & G4FieldSetupMessenger::operator= ( const G4FieldSetupMessenger & )
delete

◆ SetNewValue()

void G4FieldSetupMessenger::SetNewValue ( G4UIcommand * command,
G4String newValues )
overridevirtual

Applies command to the associated object.

Reimplemented from G4UImessenger.

Definition at line 72 of file G4FieldSetupMessenger.cc.

74{
75 // Apply command to the associated object.
76
77 if (command == fUpdateCmd)
78 {
79 G4cout << "Execute update command" << G4endl;
80 fFieldSetup->Update();
81 return;
82 }
83}
#define G4endl
Definition G4ios.hh:67
G4GLOB_DLL std::ostream G4cout

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