IORTAnalysisFileMessenger Class Reference

A messenger object of this class is created by the AnalysisManager. More...

#include <IORTAnalysisFileMessenger.hh>

Inheritance diagram for IORTAnalysisFileMessenger:

Collaboration diagram for IORTAnalysisFileMessenger:

Public Member Functions
	IORTAnalysisFileMessenger (IORTAnalysisManager *amgr)
	~IORTAnalysisFileMessenger ()
void	SetNewValue (G4UIcommand *command, G4String newValue)
	Called when new command given. More...
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Private Attributes
IORTAnalysisManager *	AnalysisManager
	handle to AnalysisManager More...
G4UIcmdWithABool *	secondaryCmd
	G4 user interface command (that takes a string argument) object Constructor requires command name and messenger class(this). More...
G4UIcmdWithAString *	DoseMatrixCmd
G4UIcmdWithAString *	FileNameCmd

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)
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
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

A messenger object of this class is created by the AnalysisManager.

The point of a messenger is to connect the G4UI with the simulation functionality. The messenger needs to contain a command object and to have SetValue method that is called once a command is set.

See also

IORTAnalysisManager

Definition at line 61 of file IORTAnalysisFileMessenger.hh.

Constructor & Destructor Documentation

IORTAnalysisFileMessenger::IORTAnalysisFileMessenger

(

IORTAnalysisManager *

amgr

)

<doc did not say what second boolean really does

Definition at line 51 of file IORTAnalysisFileMessenger.cc.

References G4UIcommand::AvailableForStates(), DoseMatrixCmd, FileNameCmd, G4State_Idle, G4State_PreInit, secondaryCmd, G4UIcmdWithAString::SetDefaultValue(), G4UIcommand::SetGuidance(), and G4UIcmdWithAString::SetParameterName().

Here is the call graph for this function:

IORTAnalysisFileMessenger::~IORTAnalysisFileMessenger

(

)

Definition at line 79 of file IORTAnalysisFileMessenger.cc.

References DoseMatrixCmd, FileNameCmd, and secondaryCmd.

Member Function Documentation

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

virtual

Called when new command given.

Parameters

command	is a pointer to the given command object
newValue	holds the argument given as a G4String

Returns

is void

Reimplemented from G4UImessenger.

Definition at line 87 of file IORTAnalysisFileMessenger.cc.

References DoseMatrixCmd, FileNameCmd, IORTAnalysisManager::GetInstance(), IORTMatrix::GetInstance(), and secondaryCmd.

Here is the call graph for this function:

Member Data Documentation

IORTAnalysisManager* IORTAnalysisFileMessenger::AnalysisManager

private

handle to AnalysisManager

Definition at line 76 of file IORTAnalysisFileMessenger.hh.

G4UIcmdWithAString* IORTAnalysisFileMessenger::DoseMatrixCmd

private

Definition at line 82 of file IORTAnalysisFileMessenger.hh.

Referenced by IORTAnalysisFileMessenger(), SetNewValue(), and ~IORTAnalysisFileMessenger().

G4UIcmdWithAString* IORTAnalysisFileMessenger::FileNameCmd

private

Definition at line 83 of file IORTAnalysisFileMessenger.hh.

Referenced by IORTAnalysisFileMessenger(), SetNewValue(), and ~IORTAnalysisFileMessenger().

G4UIcmdWithABool* IORTAnalysisFileMessenger::secondaryCmd

private

G4 user interface command (that takes a string argument) object Constructor requires command name and messenger class(this).

Definition at line 81 of file IORTAnalysisFileMessenger.hh.

Referenced by IORTAnalysisFileMessenger(), SetNewValue(), and ~IORTAnalysisFileMessenger().

---

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

• geant4.10.02.p02/examples/advanced/iort_therapy/include/IORTAnalysisFileMessenger.hh
• geant4.10.02.p02/examples/advanced/iort_therapy/src/IORTAnalysisFileMessenger.cc