G4GenericMessenger::Command Struct Reference

#include <G4GenericMessenger.hh>

Inheritance diagram for G4GenericMessenger::Command:

Collaboration diagram for G4GenericMessenger::Command:

Public Types
enum	UnitSpec { UnitCategory, UnitDefault }

Public Member Functions
	Command (G4UIcommand *cmd, const std::type_info &ti)
	Command ()
Command &	SetStates (G4ApplicationState s0)
Command &	SetStates (G4ApplicationState s0, G4ApplicationState s1)
Command &	SetStates (G4ApplicationState s0, G4ApplicationState s1, G4ApplicationState s2)
Command &	SetStates (G4ApplicationState s0, G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3)
Command &	SetStates (G4ApplicationState s0, G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3, G4ApplicationState s4)
Command &	SetRange (const G4String &range)
Command &	SetGuidance (const G4String &s0)
Command &	SetUnit (const G4String &, UnitSpec=UnitDefault)
Command &	SetUnitCategory (const G4String &u)
Command &	SetDefaultUnit (const G4String &u)
Command &	SetParameterName (const G4String &, G4bool, G4bool=false)
Command &	SetDefaultValue (const G4String &)
Command &	SetCandidates (const G4String &)
Command &	SetToBeBroadcasted (G4bool s0)
Command &	SetToBeFlushed (G4bool s0)
Command &	SetWorkerThreadOnly (G4bool s0)

Public Attributes
G4UIcommand *	command
const std::type_info *	type

Detailed Description

Definition at line 59 of file G4GenericMessenger.hh.

Member Enumeration Documentation

UnitSpec

enum G4GenericMessenger::Command::UnitSpec

Enumerator
UnitCategory
UnitDefault

Definition at line 60 of file G4GenericMessenger.hh.

{UnitCategory, UnitDefault};

Constructor & Destructor Documentation

Command() [1/2]

G4GenericMessenger::Command::Command ( G4UIcommand *  cmd, const std::type_info &  ti  )

inline

Definition at line 61 of file G4GenericMessenger.hh.

: command(cmd), type(&ti) {}

Command() [2/2]

G4GenericMessenger::Command::Command ( )

inline

Definition at line 62 of file G4GenericMessenger.hh.

: command(0), type(0) {}

Member Function Documentation

SetCandidates()

G4GenericMessenger::Command & G4GenericMessenger::Command::SetCandidates

(

const G4String &

candList

)

Definition at line 247 of file G4GenericMessenger.cc.

                                                                                            {
  G4UIparameter * theParam = command->GetParameter(0);
  theParam->SetParameterCandidates(candList);
  return *this;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetDefaultUnit()

Command& G4GenericMessenger::Command::SetDefaultUnit ( const G4String &  u )

inline

Definition at line 73 of file G4GenericMessenger.hh.

{return SetUnit(u, UnitDefault);}

Here is the call graph for this function:

SetDefaultValue()

G4GenericMessenger::Command & G4GenericMessenger::Command::SetDefaultValue

(

const G4String &

defVal

)

Definition at line 253 of file G4GenericMessenger.cc.

                                                                                            {
  G4UIparameter * theParam = command->GetParameter(0);
  theParam->SetDefaultValue(defVal);
  return *this;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetGuidance()

Command& G4GenericMessenger::Command::SetGuidance ( const G4String &  s0 )

inline

Definition at line 70 of file G4GenericMessenger.hh.

{ command->SetGuidance(s0); return *this; }

Here is the call graph for this function:

Here is the caller graph for this function:

SetParameterName()

G4GenericMessenger::Command & G4GenericMessenger::Command::SetParameterName	(	const G4String &	name,
		G4bool	omittable,
		G4bool	currentAsDefault = false
	)

Definition at line 239 of file G4GenericMessenger.cc.

                                                                                                                                     {
  G4UIparameter* theParam = command->GetParameter(0);
  theParam->SetParameterName(name);
  theParam->SetOmittable(omittable);
  theParam->SetCurrentAsDefault(currentAsDefault);
  return *this;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetRange()

Command& G4GenericMessenger::Command::SetRange ( const G4String &  range )

inline

Definition at line 69 of file G4GenericMessenger.hh.

{command->SetRange(range.c_str()); return *this;}

Here is the call graph for this function:

Here is the caller graph for this function:

SetStates() [1/5]

Command& G4GenericMessenger::Command::SetStates ( G4ApplicationState  s0 )

inline

Definition at line 64 of file G4GenericMessenger.hh.

{command->AvailableForStates(s0); return *this;}

Here is the call graph for this function:

Here is the caller graph for this function:

SetStates() [2/5]

Command& G4GenericMessenger::Command::SetStates ( G4ApplicationState  s0, G4ApplicationState  s1  )

inline

Definition at line 65 of file G4GenericMessenger.hh.

{command->AvailableForStates(s0, s1); return *this;}

Here is the call graph for this function:

SetStates() [3/5]

Command& G4GenericMessenger::Command::SetStates ( G4ApplicationState  s0, G4ApplicationState  s1, G4ApplicationState  s2  )

inline

Definition at line 66 of file G4GenericMessenger.hh.

{command->AvailableForStates(s0,s1,s2); return *this;}

Here is the call graph for this function:

SetStates() [4/5]

Command& G4GenericMessenger::Command::SetStates ( G4ApplicationState  s0, G4ApplicationState  s1, G4ApplicationState  s2, G4ApplicationState  s3  )

inline

Definition at line 67 of file G4GenericMessenger.hh.

{command->AvailableForStates(s0,s1,s2,s3); return *this;}

Here is the call graph for this function:

SetStates() [5/5]

Command& G4GenericMessenger::Command::SetStates ( G4ApplicationState  s0, G4ApplicationState  s1, G4ApplicationState  s2, G4ApplicationState  s3, G4ApplicationState  s4  )

inline

Definition at line 68 of file G4GenericMessenger.hh.

{command->AvailableForStates(s0,s1,s2,s3,s4); return *this;}

Here is the call graph for this function:

SetToBeBroadcasted()

Command& G4GenericMessenger::Command::SetToBeBroadcasted ( G4bool  s0 )

inline

Definition at line 77 of file G4GenericMessenger.hh.

{ command->SetToBeBroadcasted(s0); return *this; }

Here is the call graph for this function:

SetToBeFlushed()

Command& G4GenericMessenger::Command::SetToBeFlushed ( G4bool  s0 )

inline

Definition at line 78 of file G4GenericMessenger.hh.

{ command->SetToBeFlushed(s0); return *this; }

Here is the call graph for this function:

SetUnit()

G4GenericMessenger::Command & G4GenericMessenger::Command::SetUnit	(	const G4String &	unit,
		UnitSpec	spec = UnitDefault
	)

Definition at line 186 of file G4GenericMessenger.cc.

                                                                                                 {
  // Change the type of command (unfortunatelly this is done a posteriory)
  // We need to delete the old command before creating the new one and therefore we need to recover the information
  // before the deletetion
#ifdef G4MULTITHREADED
  G4String cmdpath = command->GetCommandPath();
  G4ExceptionDescription ed;
  ed<<"G4GenericMessenger::Command::SetUnit() is thread-unsafe and should not be used\n"
    <<"in multi-threaded mode. For your command <"<<cmdpath<<">, use\n"
    <<" DeclarePropertyWithUnit(const G4String& name, const G4String& defaultUnit,\n"
    <<"                         const G4AnyType& variable, const G4String& doc)\n"
    <<"or\n"
    <<" DeclareMethodWithUnit(const G4String& name, const G4String& defaultUnit,\n"
    <<"                       const G4AnyType& variable, const G4String& doc)\n"
    <<"to define a command with a unit <"<<unit<<">.";
  if(spec!=UnitDefault) { ed<<"\nPlease use a default unit instead of unit category."; }
  G4Exception("G4GenericMessenger::Command::SetUnit()","Intercom70001",FatalException,ed);
  return *this;
#else
  G4String cmdpath = command->GetCommandPath();
  G4UImessenger* messenger = command->GetMessenger();
  G4String range = command->GetRange();
  std::vector<G4String> guidance;
  G4String par_name = command->GetParameter(0)->GetParameterName();
  bool par_omitable = command->GetParameter(0)->IsOmittable();
  for (G4int i = 0; i < command->GetGuidanceEntries(); i++) guidance.push_back(command->GetGuidanceLine(i));
  // Before deleting the command we need to add a fake one to avoid deleting the directory entry and with its guidance
  G4UIcommand tmp((cmdpath+"_tmp").c_str(), messenger);
  delete command;

  if (*type == typeid(float) || *type == typeid(double) ) {
    G4UIcmdWithADoubleAndUnit* cmd_t = new G4UIcmdWithADoubleAndUnit(cmdpath, messenger);
    if(spec == UnitDefault) cmd_t->SetDefaultUnit(unit);
    else if(spec == UnitCategory) cmd_t->SetUnitCategory(unit);
    cmd_t->SetParameterName(par_name, par_omitable);
    command = cmd_t;
  }
  else if (*type == typeid(G4ThreeVector)) {
    G4UIcmdWith3VectorAndUnit* cmd_t = new G4UIcmdWith3VectorAndUnit(cmdpath, messenger);
    if(spec == UnitDefault) cmd_t->SetDefaultUnit(unit);
    else if(spec == UnitCategory) cmd_t->SetUnitCategory(unit);
    command = cmd_t;
  }
  else {
    G4cerr << "Only parameters of type <double> or <float> can be associated with units" << G4endl;
    return *this;
  }
  for (size_t i = 0; i < guidance.size(); i++) command->SetGuidance(guidance[i]);
  command->SetRange(range);
  return *this;
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetUnitCategory()

Command& G4GenericMessenger::Command::SetUnitCategory ( const G4String &  u )

inline

Definition at line 72 of file G4GenericMessenger.hh.

{return SetUnit(u, UnitCategory);}

Here is the call graph for this function:

SetWorkerThreadOnly()

Command& G4GenericMessenger::Command::SetWorkerThreadOnly ( G4bool  s0 )

inline

Definition at line 79 of file G4GenericMessenger.hh.

{ command->SetWorkerThreadOnly(s0); return *this; }

Here is the call graph for this function:

Member Data Documentation

command

G4UIcommand* G4GenericMessenger::Command::command

Definition at line 81 of file G4GenericMessenger.hh.

type

const std::type_info* G4GenericMessenger::Command::type

Definition at line 82 of file G4GenericMessenger.hh.

---

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

• G4GenericMessenger.hh
• G4GenericMessenger.cc