G4GenericMessenger::Command Struct Reference

#include <G4GenericMessenger.hh>

Inheritance diagram for G4GenericMessenger::Command:

Public Types
enum	UnitSpec { UnitCategory , UnitDefault }

Public Member Functions
	Command ()
	Command (G4UIcommand *cmd, const std::type_info &ti)
Command &	SetCandidates (const G4String &)
Command &	SetCandidates (G4int pIdx, const G4String &)
Command &	SetDefaultUnit (const G4String &u)
Command &	SetDefaultValue (const G4String &)
Command &	SetDefaultValue (G4int pIdx, const G4String &)
Command &	SetGuidance (const G4String &s0)
Command &	SetParameterName (const G4String &, const G4String &, const G4String &, G4bool, G4bool=false)
Command &	SetParameterName (const G4String &, G4bool, G4bool=false)
Command &	SetParameterName (G4int pIdx, const G4String &, G4bool, G4bool=false)
Command &	SetRange (const G4String &range)
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 &	SetToBeBroadcasted (G4bool s0)
Command &	SetToBeFlushed (G4bool s0)
Command &	SetUnit (const G4String &, UnitSpec=UnitDefault)
Command &	SetUnitCategory (const G4String &u)
Command &	SetWorkerThreadOnly (G4bool s0)

Data Fields
G4UIcommand *	command = nullptr
const std::type_info *	type = nullptr

Detailed Description

Definition at line 68 of file G4GenericMessenger.hh.

Member Enumeration Documentation

UnitSpec

enum G4GenericMessenger::Command::UnitSpec

Enumerator
UnitCategory
UnitDefault

Definition at line 70 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 75 of file G4GenericMessenger.hh.

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

Command() [2/2]

G4GenericMessenger::Command::Command ( )

inline

Definition at line 79 of file G4GenericMessenger.hh.

      {}

Member Function Documentation

SetCandidates() [1/2]

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

(

const G4String &

candList

)

Definition at line 387 of file G4GenericMessenger.cc.

{
  return SetCandidates(0,candList);
}

SetCandidates() [2/2]

G4GenericMessenger::Command & G4GenericMessenger::Command::SetCandidates	(	G4int	pIdx,
		const G4String &	candList
	)

Definition at line 393 of file G4GenericMessenger.cc.

{
  if(pIdx < 0 || pIdx >= (G4int)(command->GetParameterEntries()))
  {
    G4cerr << "Invalid parameter index : " << pIdx << "\nMethod ignored."
           << G4endl;
    return *this;
  }
  G4UIparameter* theParam = command->GetParameter(pIdx);
  theParam->SetParameterCandidates(candList);
  return *this;
}

References G4cerr, G4endl, and G4UIparameter::SetParameterCandidates().

SetDefaultUnit()

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

inline

Definition at line 126 of file G4GenericMessenger.hh.

      {
        return SetUnit(u, UnitDefault);
      }

References SetUnit(), and UnitDefault.

SetDefaultValue() [1/2]

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

(

const G4String &

defVal

)

Definition at line 407 of file G4GenericMessenger.cc.

{
  return SetDefaultValue(0,defVal);
}

SetDefaultValue() [2/2]

G4GenericMessenger::Command & G4GenericMessenger::Command::SetDefaultValue	(	G4int	pIdx,
		const G4String &	defVal
	)

Definition at line 413 of file G4GenericMessenger.cc.

{
  if(pIdx < 0 || pIdx >= (G4int)(command->GetParameterEntries()))
  {
    G4cerr << "Invalid parameter index : " << pIdx << "\nMethod ignored."
           << G4endl;
    return *this;
  }
  G4UIparameter* theParam = command->GetParameter(pIdx);
  theParam->SetDefaultValue(defVal);
  return *this;
}

References G4cerr, G4endl, and G4UIparameter::SetDefaultValue().

SetGuidance()

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

inline

Definition at line 116 of file G4GenericMessenger.hh.

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

References command, G4InuclParticleNames::s0, and G4UIcommand::SetGuidance().

SetParameterName() [1/3]

G4GenericMessenger::Command & G4GenericMessenger::Command::SetParameterName	(	const G4String &	namex,
		const G4String &	namey,
		const G4String &	namez,
		G4bool	omittable,
		G4bool	currentAsDefault = false
	)

Definition at line 362 of file G4GenericMessenger.cc.

{
  if(*type != typeid(G4ThreeVector))
  {
    G4cerr << "This SetParameterName method is for G4ThreeVector!! " 
           << "Method ignored." << G4endl;
    return *this;
  }
  G4UIparameter* theParam = command->GetParameter(0);
  theParam->SetParameterName(namex);
  theParam->SetOmittable(omittable);
  theParam->SetCurrentAsDefault(currentAsDefault);
  theParam = command->GetParameter(1);
  theParam->SetParameterName(namey);
  theParam->SetOmittable(omittable);
  theParam->SetCurrentAsDefault(currentAsDefault);
  theParam = command->GetParameter(2);
  theParam->SetParameterName(namez);
  theParam->SetOmittable(omittable);
  theParam->SetCurrentAsDefault(currentAsDefault);
  return *this;
}

References G4cerr, G4endl, G4UIparameter::SetCurrentAsDefault(), G4UIparameter::SetOmittable(), and G4UIparameter::SetParameterName().

SetParameterName() [2/3]

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

Definition at line 339 of file G4GenericMessenger.cc.

{ 
  return SetParameterName(0,name,omittable,currentAsDefault);
}

References G4InuclParticleNames::name().

SetParameterName() [3/3]

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

Definition at line 345 of file G4GenericMessenger.cc.

{
  if(pIdx < 0 || pIdx >= (G4int)(command->GetParameterEntries()))
  {
    G4cerr << "Invalid parameter index : " << pIdx << "\nMethod ignored."
           << G4endl;
    return *this;
  }
  G4UIparameter* theParam = command->GetParameter(pIdx);
  theParam->SetParameterName(name);
  theParam->SetOmittable(omittable);
  theParam->SetCurrentAsDefault(currentAsDefault);
  return *this;
}

References G4cerr, G4endl, G4InuclParticleNames::name(), G4UIparameter::SetCurrentAsDefault(), G4UIparameter::SetOmittable(), and G4UIparameter::SetParameterName().

SetRange()

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

inline

Definition at line 111 of file G4GenericMessenger.hh.

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

References command, and G4UIcommand::SetRange().

SetStates() [1/5]

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

inline

Definition at line 82 of file G4GenericMessenger.hh.

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

References G4UIcommand::AvailableForStates(), command, and G4InuclParticleNames::s0.

Referenced by G4SteppingVerboseWithUnits::SetManager().

SetStates() [2/5]

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

inline

Definition at line 87 of file G4GenericMessenger.hh.

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

References G4UIcommand::AvailableForStates(), command, and G4InuclParticleNames::s0.

SetStates() [3/5]

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

inline

Definition at line 92 of file G4GenericMessenger.hh.

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

References G4UIcommand::AvailableForStates(), command, and G4InuclParticleNames::s0.

SetStates() [4/5]

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

inline

Definition at line 98 of file G4GenericMessenger.hh.

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

References G4UIcommand::AvailableForStates(), command, and G4InuclParticleNames::s0.

SetStates() [5/5]

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

inline

Definition at line 104 of file G4GenericMessenger.hh.

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

References G4UIcommand::AvailableForStates(), command, and G4InuclParticleNames::s0.

SetToBeBroadcasted()

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

inline

Definition at line 138 of file G4GenericMessenger.hh.

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

References command, G4InuclParticleNames::s0, and G4UIcommand::SetToBeBroadcasted().

SetToBeFlushed()

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

inline

Definition at line 143 of file G4GenericMessenger.hh.

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

References command, G4InuclParticleNames::s0, and G4UIcommand::SetToBeFlushed().

SetUnit()

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

Definition at line 260 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
  if(G4Threading::IsMultithreadedApplication())
  {
    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;
  }
 
  G4String cmdpath         = command->GetCommandPath();
  G4UImessenger* messenger = command->GetMessenger();
  G4String range           = command->GetRange();
  std::vector<G4String> guidance;
  G4String par_name   = command->GetParameter(0)->GetParameterName();
  G4bool par_omitable = command->GetParameter(0)->IsOmittable();
  for(std::size_t 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(std::size_t i = 0; i < guidance.size(); ++i)
    command->SetGuidance(guidance[i]);
  command->SetRange(range);
  return *this;
}

References command, FatalException, G4cerr, G4endl, G4Exception(), G4UIcommand::GetCommandPath(), G4UIcommand::GetGuidanceEntries(), G4UIcommand::GetGuidanceLine(), G4UIcommand::GetMessenger(), G4UIcommand::GetParameter(), G4UIparameter::GetParameterName(), G4UIcommand::GetRange(), G4Threading::IsMultithreadedApplication(), G4UIparameter::IsOmittable(), G4UIcmdWith3VectorAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), G4UIcommand::SetGuidance(), G4UIcmdWithADoubleAndUnit::SetParameterName(), G4UIcommand::SetRange(), G4UIcmdWith3VectorAndUnit::SetUnitCategory(), G4UIcmdWithADoubleAndUnit::SetUnitCategory(), type, UnitCategory, and UnitDefault.

Referenced by SetDefaultUnit(), and SetUnitCategory().

SetUnitCategory()

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

inline

Definition at line 122 of file G4GenericMessenger.hh.

      {
        return SetUnit(u, UnitCategory);
      }

References SetUnit(), and UnitCategory.

SetWorkerThreadOnly()

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

inline

Definition at line 148 of file G4GenericMessenger.hh.

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

References command, G4InuclParticleNames::s0, and G4UIcommand::SetWorkerThreadOnly().

Field Documentation

command

G4UIcommand* G4GenericMessenger::Command::command = nullptr

Definition at line 154 of file G4GenericMessenger.hh.

Referenced by SetGuidance(), SetRange(), SetStates(), SetToBeBroadcasted(), SetToBeFlushed(), SetUnit(), and SetWorkerThreadOnly().

type

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

Definition at line 155 of file G4GenericMessenger.hh.

Referenced by SetUnit().

---

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

• source/intercoms/include/G4GenericMessenger.hh
• source/intercoms/src/G4GenericMessenger.cc