#include <G4UImessenger.hh>

Inheritance diagram for G4UImessenger:

Public Member Functions
	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

Protected Member Functions
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
G4UIdirectory *	baseDir = nullptr

G4String	baseDirName = ""

G4bool	commandsShouldBeInMaster = false

Detailed Description

Definition at line 46 of file G4UImessenger.hh.

Constructor & Destructor Documentation

◆ G4UImessenger() [1/2]

G4UImessenger::G4UImessenger ( )

Definition at line 40 of file G4UImessenger.cc.

41{

42}

◆ G4UImessenger() [2/2]

G4UImessenger::G4UImessenger	(	const G4String &	path,
		const G4String &	dsc,
		G4bool	commandsToBeBroadcasted = `true`
	)

Definition at line 45 of file G4UImessenger.cc.

{
  CreateDirectory(path, dsc, commandsToBeBroadcasted);
}

◆ ~G4UImessenger()

G4UImessenger::~G4UImessenger ( )

virtual

Definition at line 52 of file G4UImessenger.cc.

{
  delete baseDir;
}

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand * newCommand )

protected

Definition at line 150 of file G4UImessenger.cc.

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

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool b )

protected

Definition at line 98 of file G4UImessenger.cc.

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

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inline

Definition at line 77 of file G4UImessenger.hh.

    {
      return commandsShouldBeInMaster;
    }

◆ CreateCommand()

template<typename T >

T * G4UImessenger::CreateCommand	(	const G4String &	cname,
		const G4String &	dsc
	)

protected

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;
}

◆ CreateDirectory()

void G4UImessenger::CreateDirectory	(	const G4String &	path,
		const G4String &	dsc,
		G4bool	commandsToBeBroadcasted = `true`
	)

protected

Definition at line 157 of file G4UImessenger.cc.

{
  G4UImanager* ui = G4UImanager::GetUIpointer();
 
  G4String fullpath = path;
  if(fullpath(fullpath.length() - 1) != '/')
    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());
  }
}

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

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double a )

protected

Definition at line 90 of file G4UImessenger.cc.

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

Referenced by G4UIcontrolMessenger::SetNewValue().

◆ GetCurrentValue()

G4String G4UImessenger::GetCurrentValue ( G4UIcommand * command )

virtual

Definition at line 58 of file G4UImessenger.cc.

{
  G4String nullString;
  return nullString;
}

Referenced by G4UIcommand::DoIt(), and G4UIcommand::GetCurrentValue().

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int i )

protected

Definition at line 82 of file G4UImessenger.cc.

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

Referenced by G4ParticleGunMessenger::GetCurrentValue().

◆ operator!=()

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

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

◆ operator==()

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

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetNewValue()

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

virtual

Definition at line 65 of file G4UImessenger.cc.

66{

67}

Referenced by G4UIcommand::DoIt().

◆ StoB()

G4bool G4UImessenger::StoB ( G4String s )

protected

Definition at line 137 of file G4UImessenger.cc.

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

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

◆ StoD()

G4double G4UImessenger::StoD ( G4String s )

protected

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(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddText2D::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4PolarizationMessenger::SetNewValue().

◆ StoI()

G4int G4UImessenger::StoI ( G4String s )

protected

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(), G4ScoringMessenger::MeshBinCommand(), G4LocalThreadCoutMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoL()

G4long G4UImessenger::StoL ( G4String s )

protected

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().

Member Data Documentation

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protected

Definition at line 102 of file G4UImessenger.hh.

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

◆ baseDirName

G4String G4UImessenger::baseDirName = ""

protected

Definition at line 103 of file G4UImessenger.hh.

Referenced by CreateCommand(), and CreateDirectory().

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protected

Definition at line 104 of file G4UImessenger.hh.

Referenced by CommandsShouldBeInMaster().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4UImessenger() [1/2]

◆ G4UImessenger() [2/2]

◆ ~G4UImessenger()

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ operator!=()

◆ operator==()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Member Data Documentation

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster