G4GenericMessenger Class Reference

#include <G4GenericMessenger.hh>

Inheritance diagram for G4GenericMessenger:

Classes
struct	Command
struct	Method
struct	Property

Public Member Functions
	G4GenericMessenger (void *obj, const G4String &dir="", const G4String &doc="")
virtual	~G4GenericMessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
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="")
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="")
void	SetDirectory (const G4String &dir)
void	SetGuidance (const G4String &s)
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	operator!= (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (G4String s)
G4long	StoL (G4String s)
G4double	StoD (G4String s)
G4bool	StoB (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
G4UIdirectory *	baseDir = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false

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 52 of file G4GenericMessenger.cc.

  : directory(dir)
  , object(obj)
{
  // Check if parent commnand is already existing.
  // In fact there is no way to check this. UImanager->GetTree()->FindPath()
  // will always rerurn NULL is a dicrectory is given
  std::size_t pos = dir.find_last_of('/', dir.size() - 2);
  while(pos != 0 && pos != std::string::npos)
  {
    G4UIdirectory* d  = new G4UIdirectory(dir.substr(0, pos + 1).c_str());
    G4String guidance = "Commands for ";
    guidance += dir.substr(1, pos - 1);
    d->SetGuidance(guidance);
    pos = dir.find_last_of('/', pos - 1);
  }
  dircmd = new G4UIdirectory(dir);
  dircmd->SetGuidance(doc);
}

~G4GenericMessenger()

G4GenericMessenger::~G4GenericMessenger ( )

virtual

Definition at line 73 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;
}

Member Function Documentation

DeclareMethod()

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

Definition at line 137 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)
  {
    cmd->SetParameter(new G4UIparameter("arg", 's', false));
  }
  return methods[name] = Method(fun, object, cmd);
}

DeclareMethodWithUnit()

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

Definition at line 151 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);
}

DeclareProperty()

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

Definition at line 82 of file G4GenericMessenger.cc.

{
  G4String fullpath = directory + name;
  G4UIcommand* cmd  = new G4UIcommand(fullpath.c_str(), this);
  if(doc != "")
    cmd->SetGuidance(doc);
  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));
  return properties[name] = Property(var, cmd);
}

Referenced by DeclarePropertyWithUnit().

DeclarePropertyWithUnit()

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

Definition at line 106 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);
}

GetCurrentValue()

G4String G4GenericMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 176 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();
  }
}

SetDirectory()

void G4GenericMessenger::SetDirectory ( const G4String &  dir )

inline

Definition at line 190 of file G4GenericMessenger.hh.

{ directory = dir; }

SetGuidance()

void G4GenericMessenger::SetGuidance

(

const G4String &

s

)

Definition at line 231 of file G4GenericMessenger.cc.

{
  dircmd->SetGuidance(s);
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 196 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();
    }
  }
}

---

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

• G4GenericMessenger.hh
• G4GenericMessenger.cc