#include <G4UImessenger.hh>

Inheritance diagram for G4UImessenger:

Public Member Functions
	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	CommandsShouldBeInMaster () const

Protected Member Functions
G4String	ItoS (G4int i)

G4String	LtoS (G4long l)

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

default

◆ G4UImessenger() [2/2]

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

Definition at line 44 of file G4UImessenger.cc.

{
  CreateDirectory(path, dsc, commandsToBeBroadcasted);
}

◆ ~G4UImessenger()

G4UImessenger::~G4UImessenger ( )

virtual

Definition at line 51 of file G4UImessenger.cc.

{
  delete baseDir;
}

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand * newCommand )

protected

Definition at line 121 of file G4UImessenger.cc.

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

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool b )

protected

Definition at line 90 of file G4UImessenger.cc.

{
  return b ? "true" : "0";
}

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inline

Definition at line 72 of file G4UImessenger.hh.

72{ return commandsShouldBeInMaster; }

G4UImessenger::commandsShouldBeInMaster

G4bool commandsShouldBeInMaster

Definition G4UImessenger.hh:95

◆ CreateCommand()

template<typename T >

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

protected

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

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

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double a )

protected

Definition at line 82 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 57 of file G4UImessenger.cc.

{
  return G4String{};
}

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

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int i )

protected

Definition at line 66 of file G4UImessenger.cc.

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

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

◆ LtoS()

G4String G4UImessenger::LtoS ( G4long l )

protected

Definition at line 74 of file G4UImessenger.cc.

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

◆ SetNewValue()

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

virtual

Definition at line 63 of file G4UImessenger.cc.

63{}

Referenced by G4UIcommand::DoIt().

◆ StoB()

G4bool G4UImessenger::StoB ( G4String s )

protected

Definition at line 114 of file G4UImessenger.cc.

{
  G4String v = G4StrUtil::to_upper_copy(std::move(str));
  return (v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE");
}

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

◆ StoD()

G4double G4UImessenger::StoD ( const G4String & s )

protected

Definition at line 108 of file G4UImessenger.cc.

{
  return G4UIparsing::StoT<G4double>(str);
}

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

◆ StoI()

G4int G4UImessenger::StoI ( const G4String & s )

protected

Definition at line 96 of file G4UImessenger.cc.

{
  return G4UIparsing::StoT<G4int>(str);
}

Referenced by G4ScoringMessenger::Fill1D(), G4ScoringMessenger::MeshBinCommand(), G4GMocrenMessenger::SetNewValue(), G4LocalThreadCoutMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4UIcontrolMessenger::SetNewValue().

◆ StoL()

G4long G4UImessenger::StoL ( const G4String & s )

protected

Definition at line 102 of file G4UImessenger.cc.

{
  return G4UIparsing::StoT<G4long>(str);
}

Referenced by G4RunMessenger::SetNewValue().

Member Data Documentation

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protected

Definition at line 93 of file G4UImessenger.hh.

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

◆ baseDirName

G4String G4UImessenger::baseDirName = ""

protected

Definition at line 94 of file G4UImessenger.hh.

Referenced by CreateCommand(), and CreateDirectory().

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protected

Definition at line 95 of file G4UImessenger.hh.

Referenced by CommandsShouldBeInMaster(), and G4QSSMessenger::G4QSSMessenger().

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

◆ LtoS()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Member Data Documentation

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster