G4GenericMessenger Class Reference

#include <G4GenericMessenger.hh>

Inheritance diagram for G4GenericMessenger:

Data Structures
struct	Command
struct	Method
struct	Property

Public Member Functions
G4bool	CommandsShouldBeInMaster () const
Command &	DeclareMethod (const G4String &name, const G4AnyMethod &fun, const G4String &doc="")
Command &	DeclareMethodWithUnit (const G4String &name, const G4String &defaultUnit, const G4AnyMethod &fun, const G4String &doc="")
Command &	DeclareProperty (const G4String &name, const G4AnyType &variable, const G4String &doc="")
Command &	DeclarePropertyWithUnit (const G4String &name, const G4String &defaultUnit, const G4AnyType &variable, const G4String &doc="")
	G4GenericMessenger (void *obj, const G4String &dir="", const G4String &doc="")
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	operator!= (const G4UImessenger &messenger) const
G4bool	operator== (const G4UImessenger &messenger) const
void	SetDirectory (const G4String &dir)
void	SetGuidance (const G4String &s)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
void	Sort (G4bool val=true)
virtual	~G4GenericMessenger ()

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
G4UIdirectory *	baseDir = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false

Private Attributes
G4UIdirectory *	dircmd = nullptr
G4String	directory
std::map< G4String, Method >	methods
void *	object = nullptr
std::map< G4String, Property >	properties

Detailed Description

Definition at line 48 of file G4GenericMessenger.hh.

Constructor & Destructor Documentation

G4GenericMessenger()

G4GenericMessenger::G4GenericMessenger	(	void *	obj,
		const G4String &	dir = "",
		const G4String &	doc = ""
	)

Definition at line 63 of file G4GenericMessenger.cc.

  : directory(dir)
  , object(obj)
{
  dircmd = new G4UIdirectory(dir);
  dircmd->SetGuidance(doc);
}

References dircmd, and G4UIcommand::SetGuidance().

~G4GenericMessenger()

G4GenericMessenger::~G4GenericMessenger ( )

virtual

Definition at line 72 of file G4GenericMessenger.cc.

{
  delete dircmd;
  for(auto i = properties.cbegin(); i != properties.cend(); ++i)
    delete i->second.command;
  for(auto i = methods.cbegin(); i != methods.cend(); ++i)
    delete i->second.command;
}

References dircmd, methods, and properties.

Member Function Documentation

AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand *  newCommand )

protectedinherited

Definition at line 149 of file G4UImessenger.cc.

{
  G4cerr << "Warning : Old style definition of G4UIcommand <"
         << newCommand->GetCommandPath() << ">." << G4endl;
}

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

BtoS()

G4String G4UImessenger::BtoS ( G4bool  b )

protectedinherited

Definition at line 98 of file G4UImessenger.cc.

{
  G4String vl = "0";
  if(b)
    vl = "true";
  return vl;
}

CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inlineinherited

Definition at line 77 of file G4UImessenger.hh.

    {
      return 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.

{
  G4String path;
  if(cname[0] != '/')
  {
    path = baseDirName + cname;
    if(path[0] != '/')
      path = "/" + path;
  }
 
  T* command = new T(path.c_str(), this);
  command->SetGuidance(dsc.c_str());
 
  return command;
}

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.

{
  G4UImanager* ui = G4UImanager::GetUIpointer();
 
  G4String fullpath = path;
  if(fullpath.back() != '/')
    fullpath.append("/");
 
  G4UIcommandTree* tree = ui->GetTree()->FindCommandTree(fullpath.c_str());
  if(tree != nullptr)
  {
    baseDirName = tree->GetPathName();
  }
  else
  {
    baseDir     = new G4UIdirectory(fullpath.c_str(), commandsToBeBroadcasted);
    baseDirName = fullpath;
    baseDir->SetGuidance(dsc.c_str());
  }
}

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

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

DeclareMethod()

G4GenericMessenger::Command & G4GenericMessenger::DeclareMethod	(	const G4String &	name,
		const G4AnyMethod &	fun,
		const G4String &	doc = ""
	)

Definition at line 146 of file G4GenericMessenger.cc.

{
  G4String fullpath = directory + name;
  G4UIcommand* cmd  = new G4UIcommand(fullpath.c_str(), this);
  if(doc != "")
    cmd->SetGuidance(doc);
  for(std::size_t i = 0; i < fun.NArg(); ++i)
  {
    G4String argNam = "arg" + ItoS(i);
    char ptype = 's';
    auto& tInfo = fun.ArgType(i);
    if(tInfo == typeid(int) || tInfo == typeid(long) ||
       tInfo == typeid(unsigned int) ||
       tInfo == typeid(unsigned long))
    { ptype = 'i'; }
    else if(tInfo == typeid(float) || tInfo == typeid(double))
    { ptype = 'd'; }
    else if(tInfo == typeid(bool))
    { ptype = 'b'; }
    else if(tInfo == typeid(G4String))
    { ptype = 's'; }
    else
    { ptype = 's'; }
    cmd->SetParameter(new G4UIparameter(argNam, ptype, false));
  }
  return methods[name] = Method(fun, object, cmd);
}

References G4AnyMethod::ArgType(), directory, G4UImessenger::ItoS(), methods, G4InuclParticleNames::name(), G4AnyMethod::NArg(), G4UIcommand::SetGuidance(), and G4UIcommand::SetParameter().

DeclareMethodWithUnit()

G4GenericMessenger::Command & G4GenericMessenger::DeclareMethodWithUnit	(	const G4String &	name,
		const G4String &	defaultUnit,
		const G4AnyMethod &	fun,
		const G4String &	doc = ""
	)

Definition at line 175 of file G4GenericMessenger.cc.

{
  G4String fullpath = directory + name;
  if(fun.NArg() != 1)
  {
    G4ExceptionDescription ed;
    ed << "G4GenericMessenger::DeclareMethodWithUnit() does not support a "
          "method that has more than\n"
       << "one arguments (or no argument). Please use "
          "G4GenericMessenger::DeclareMethod method for\n"
       << "your command <" << fullpath << ">.";
    G4Exception("G4GenericMessenger::DeclareMethodWithUnit()", "Intercom70002",
                FatalException, ed);
  }
  G4UIcommand* cmd = new G4UIcmdWithADoubleAndUnit(fullpath.c_str(), this);
  (static_cast<G4UIcmdWithADoubleAndUnit*>(cmd))
    ->SetParameterName("value", false, false);
  (static_cast<G4UIcmdWithADoubleAndUnit*>(cmd))->SetDefaultUnit(defaultUnit);
  if(doc != "")
    cmd->SetGuidance(doc);
  return methods[name] = Method(fun, object, cmd);
}

References directory, FatalException, G4Exception(), methods, G4InuclParticleNames::name(), G4AnyMethod::NArg(), and G4UIcommand::SetGuidance().

DeclareProperty()

G4GenericMessenger::Command & G4GenericMessenger::DeclareProperty	(	const G4String &	name,
		const G4AnyType &	variable,
		const G4String &	doc = ""
	)

Definition at line 81 of file G4GenericMessenger.cc.

{
  G4String fullpath = directory + name;
  G4UIcommand* cmd = nullptr;
  if(var.TypeInfo() == typeid(G4ThreeVector))
  {
    cmd = new G4UIcmdWith3Vector(fullpath.c_str(), this);
    (static_cast<G4UIcmdWith3Vector*>(cmd))
      ->SetParameterName("valueX", "valueY", "valueZ", false, false);
  }
  else
  {
    cmd  = new G4UIcommand(fullpath.c_str(), this);
    char ptype;
    if(var.TypeInfo() == typeid(int) || var.TypeInfo() == typeid(long) ||
       var.TypeInfo() == typeid(unsigned int) ||
       var.TypeInfo() == typeid(unsigned long))
    { ptype = 'i'; }
    else if(var.TypeInfo() == typeid(float) || var.TypeInfo() == typeid(double))
    { ptype = 'd'; }
    else if(var.TypeInfo() == typeid(bool))
    { ptype = 'b'; }
    else if(var.TypeInfo() == typeid(G4String))
    { ptype = 's'; }
    else
    { ptype = 's'; }
    cmd->SetParameter(new G4UIparameter("value", ptype, false));
  }
  if(doc != "")
  { cmd->SetGuidance(doc); }
  return properties[name] = Property(var, cmd);
}

References directory, G4InuclParticleNames::name(), properties, G4UIcommand::SetGuidance(), G4UIcommand::SetParameter(), and G4AnyType::TypeInfo().

Referenced by DeclarePropertyWithUnit(), and G4SteppingVerboseWithUnits::SetManager().

DeclarePropertyWithUnit()

G4GenericMessenger::Command & G4GenericMessenger::DeclarePropertyWithUnit	(	const G4String &	name,
		const G4String &	defaultUnit,
		const G4AnyType &	variable,
		const G4String &	doc = ""
	)

Definition at line 115 of file G4GenericMessenger.cc.

{
  if(var.TypeInfo() != typeid(float) && var.TypeInfo() != typeid(double) &&
     var.TypeInfo() != typeid(G4ThreeVector))
  {
    return DeclareProperty(name, var, doc);
  }
  G4String fullpath = directory + name;
  G4UIcommand* cmd;
  if(var.TypeInfo() == typeid(float) || var.TypeInfo() == typeid(double))
  {
    cmd = new G4UIcmdWithADoubleAndUnit(fullpath.c_str(), this);
    (static_cast<G4UIcmdWithADoubleAndUnit*>(cmd))
      ->SetParameterName("value", false, false);
    (static_cast<G4UIcmdWithADoubleAndUnit*>(cmd))->SetDefaultUnit(defaultUnit);
  }
  else
  {
    cmd = new G4UIcmdWith3VectorAndUnit(fullpath.c_str(), this);
    (static_cast<G4UIcmdWith3VectorAndUnit*>(cmd))
      ->SetParameterName("valueX", "valueY", "valueZ", false, false);
    (static_cast<G4UIcmdWith3VectorAndUnit*>(cmd))->SetDefaultUnit(defaultUnit);
  }
 
  if(doc != "")
    cmd->SetGuidance(doc);
  return properties[name] = Property(var, cmd);
}

References DeclareProperty(), directory, G4InuclParticleNames::name(), properties, G4UIcommand::SetGuidance(), and G4AnyType::TypeInfo().

DtoS()

G4String G4UImessenger::DtoS ( G4double  a )

protectedinherited

Definition at line 90 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << a;
  return G4String(os.str());
}

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

GetCurrentValue()

G4String G4GenericMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 200 of file G4GenericMessenger.cc.

{
  if(properties.find(command->GetCommandName()) != properties.cend())
  {
    Property& p = properties[command->GetCommandName()];
    return p.variable.ToString();
  }
  else if(methods.find(command->GetCommandName()) != methods.cend())
  {
    G4cout << " GetCurrentValue() is not available for a command defined by "
              "G4GenericMessenger::DeclareMethod()."
           << G4endl;
    return G4String();
  }
  else
  {
    throw G4InvalidUICommand();
  }
}

References G4cout, G4endl, G4UIcommand::GetCommandName(), methods, properties, G4AnyType::ToString(), and G4GenericMessenger::Property::variable.

ItoS()

G4String G4UImessenger::ItoS ( G4int  i )

protectedinherited

Definition at line 82 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << i;
  return G4String(os.str());
}

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

operator!=()

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

inherited

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

operator==()

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

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

SetDirectory()

void G4GenericMessenger::SetDirectory ( const G4String &  dir )

inline

Definition at line 195 of file G4GenericMessenger.hh.

{ directory = dir; }

References directory.

SetGuidance()

void G4GenericMessenger::SetGuidance

(

const G4String &

s

)

Definition at line 255 of file G4GenericMessenger.cc.

{
  dircmd->SetGuidance(s);
}

References dircmd, s, and G4UIcommand::SetGuidance().

SetNewValue()

void G4GenericMessenger::SetNewValue ( G4UIcommand *  command, G4String  newValue  )

virtual

Reimplemented from G4UImessenger.

Definition at line 220 of file G4GenericMessenger.cc.

{
  // Check if there are units on this commands
  if(typeid(*command) == typeid(G4UIcmdWithADoubleAndUnit))
  {
    newValue = G4UIcommand::ConvertToString(
      G4UIcommand::ConvertToDimensionedDouble(newValue));
  }
  else if(typeid(*command) == typeid(G4UIcmdWith3VectorAndUnit))
  {
    newValue = G4UIcommand::ConvertToString(
      G4UIcommand::ConvertToDimensioned3Vector(newValue));
  }
 
  if(properties.find(command->GetCommandName()) != properties.cend())
  {
    Property& p = properties[command->GetCommandName()];
    p.variable.FromString(newValue);
  }
  else if(methods.find(command->GetCommandName()) != methods.cend())
  {
    Method& m = methods[command->GetCommandName()];
    if(m.method.NArg() == 0)
      m.method.operator()(m.object);
    else if(m.method.NArg() > 0)
    {
      m.method.operator()(m.object, newValue);
    }
    else
    {
      throw G4InvalidUICommand();
    }
  }
}

References G4UIcommand::ConvertToDimensioned3Vector(), G4UIcommand::ConvertToDimensionedDouble(), G4UIcommand::ConvertToString(), G4AnyType::FromString(), G4UIcommand::GetCommandName(), m, methods, properties, and G4GenericMessenger::Property::variable.

Sort()

void G4GenericMessenger::Sort ( G4bool  val = true )

inline

Definition at line 197 of file G4GenericMessenger.hh.

    { if(dircmd) dircmd->Sort(val); }

References dircmd, and G4UIdirectory::Sort().

StoB()

G4bool G4UImessenger::StoB ( G4String  s )

protectedinherited

Definition at line 137 of file G4UImessenger.cc.

{
  G4String v = G4StrUtil::to_upper_copy(str);
  G4bool vl = false;
  if(v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE")
  {
    vl = true;
  }
  return vl;
}

References G4StrUtil::to_upper_copy().

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

StoD()

G4double G4UImessenger::StoD ( G4String  s )

protectedinherited

Definition at line 127 of file G4UImessenger.cc.

{
  G4double vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoreQuantityMessenger::FParticleWithEnergyCommand(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddText2D::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4PolarizationMessenger::SetNewValue().

StoI()

G4int G4UImessenger::StoI ( G4String  s )

protectedinherited

Definition at line 107 of file G4UImessenger.cc.

{
  G4int vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoringMessenger::Fill1D(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4ParticleGunMessenger::IonLevelCommand(), G4GeneralParticleSourceMessenger::IonLvlCommand(), G4ScoringMessenger::MeshBinCommand(), G4LocalThreadCoutMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

StoL()

G4long G4UImessenger::StoL ( G4String  s )

protectedinherited

Definition at line 117 of file G4UImessenger.cc.

{
  G4long vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4RunMessenger::SetNewValue().

Field Documentation

baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protectedinherited

Definition at line 102 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateDirectory(), and G4UImessenger::~G4UImessenger().

baseDirName

G4String G4UImessenger::baseDirName = ""

protectedinherited

Definition at line 103 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateCommand(), and G4UImessenger::CreateDirectory().

commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protectedinherited

Definition at line 104 of file G4UImessenger.hh.

Referenced by G4UImessenger::CommandsShouldBeInMaster(), and G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger().

dircmd

G4UIdirectory* G4GenericMessenger::dircmd = nullptr

private

Definition at line 204 of file G4GenericMessenger.hh.

Referenced by G4GenericMessenger(), SetGuidance(), Sort(), and ~G4GenericMessenger().

directory

G4String G4GenericMessenger::directory

private

Definition at line 205 of file G4GenericMessenger.hh.

Referenced by DeclareMethod(), DeclareMethodWithUnit(), DeclareProperty(), DeclarePropertyWithUnit(), and SetDirectory().

methods

std::map<G4String, Method> G4GenericMessenger::methods

private

Definition at line 203 of file G4GenericMessenger.hh.

Referenced by DeclareMethod(), DeclareMethodWithUnit(), GetCurrentValue(), SetNewValue(), and ~G4GenericMessenger().

object

void* G4GenericMessenger::object = nullptr

private

Definition at line 206 of file G4GenericMessenger.hh.

properties

std::map<G4String, Property> G4GenericMessenger::properties

private

Definition at line 202 of file G4GenericMessenger.hh.

Referenced by DeclareProperty(), DeclarePropertyWithUnit(), GetCurrentValue(), SetNewValue(), and ~G4GenericMessenger().

---

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

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