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="")
	~G4GenericMessenger () override
G4String	GetCurrentValue (G4UIcommand *command) override
void	SetNewValue (G4UIcommand *command, G4String newValue) override
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)
void	Sort (G4bool val=true)
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)
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 (const G4String &s)
G4long	StoL (const G4String &s)
G4double	StoD (const 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 62 of file G4GenericMessenger.cc.

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

~G4GenericMessenger()

G4GenericMessenger::~G4GenericMessenger ( )

override

Definition at line 71 of file G4GenericMessenger.cc.

{
  delete dircmd;
  for(const auto& propertie : properties)
  {
    delete propertie.second.command;
  }
  for(const auto& method : methods)
  {
    delete method.second.command;
  }
}

Member Function Documentation

DeclareMethod()

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

Definition at line 151 of file G4GenericMessenger.cc.

{
  G4String fullpath = directory + name;
  auto* cmd         = new G4UIcommand(fullpath.c_str(), this);
  if(!doc.empty())
  {
    cmd->SetGuidance(doc);
  }
  for(std::size_t i = 0; i < fun.NArg(); ++i)
  {
    G4String argNam = "arg" + ItoS((G4int)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);
}

DeclareMethodWithUnit()

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

Definition at line 182 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.empty())
  {
    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 84 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.empty())
  { cmd->SetGuidance(doc); }
  return properties[name] = Property(var, cmd);
}

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 118 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.empty())
  {
    cmd->SetGuidance(doc);
  }
  return properties[name] = Property(var, cmd);
}

GetCurrentValue()

G4String G4GenericMessenger::GetCurrentValue ( G4UIcommand *  command )

overridevirtual

Reimplemented from G4UImessenger.

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

{ directory = dir; }

SetGuidance()

void G4GenericMessenger::SetGuidance

(

const G4String &

s

)

Definition at line 266 of file G4GenericMessenger.cc.

{
  dircmd->SetGuidance(s);
}

SetNewValue()

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

overridevirtual

Reimplemented from G4UImessenger.

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

Sort()

void G4GenericMessenger::Sort ( G4bool  val = true )

inline

Definition at line 195 of file G4GenericMessenger.hh.

    {
      if(dircmd != nullptr)
      {
        dircmd->Sort(val);
      }
    }

---

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

• G4GenericMessenger.hh
• G4GenericMessenger.cc