IORTAnalysisFileMessenger Class Reference

#include <IORTAnalysisFileMessenger.hh>

Inheritance diagram for IORTAnalysisFileMessenger:

Public Member Functions
	IORTAnalysisFileMessenger ()
	~IORTAnalysisFileMessenger ()
void	SetNewValue (G4UIcommand *command, G4String newValue)
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

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

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

(

)

Definition at line 54 of file IORTAnalysisFileMessenger.cc.

References G4State_Idle, and G4State_PreInit.

{  
  secondaryCmd = new G4UIcmdWithABool("/analysis/secondary",this);
  secondaryCmd -> SetParameterName("secondary", true);
  secondaryCmd -> SetDefaultValue("true");
  secondaryCmd -> SetGuidance("Set if dose/fluence for the secondary particles will be written" 
                "\n[usage]: /analysis/secondary [true/false]"); 
  secondaryCmd -> AvailableForStates(G4State_Idle, G4State_PreInit);

  DoseMatrixCmd = new G4UIcmdWithAString("/analysis/writeDoseFile",this);
  DoseMatrixCmd->SetGuidance("Write the dose/fluence to an ASCII file");
  DoseMatrixCmd->SetDefaultValue("Dose.out");
  DoseMatrixCmd->SetParameterName("choice",true); 

  // With this messenger you can:
  // give a name to the generated .root file
  // One can use this messenger to define a different .root file name other then the default one 
#ifdef G4ANALYSIS_USE_ROOT
  FileNameCmd = new G4UIcmdWithAString("/analysis/setAnalysisFile",this);
  FileNameCmd->SetGuidance("Set the .root filename for the root-output");
  FileNameCmd->SetDefaultValue("default.root");
  FileNameCmd->SetParameterName("choice",true); ///<doc did not say what second boolean really does
  FileNameCmd->AvailableForStates(G4State_Idle,G4State_PreInit);
#endif

}

IORTAnalysisFileMessenger::~IORTAnalysisFileMessenger

(

)

Definition at line 83 of file IORTAnalysisFileMessenger.cc.

{
  delete secondaryCmd; 
  delete DoseMatrixCmd; 
#ifdef G4ANALYSIS_USE_ROOT
  delete FileNameCmd;
#endif
}

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 93 of file IORTAnalysisFileMessenger.cc.

References IORTAnalysisManager::GetInstance(), and IORTMatrix::GetInstance().

{ 
    if (command == secondaryCmd)
    {
    if (IORTMatrix::GetInstance())
    {
        IORTMatrix::GetInstance() -> secondary = secondaryCmd -> GetNewBoolValue(newValue);
    }
    }

    else if (command == DoseMatrixCmd) // Filename can be passed here TODO 
    { 
    if ( IORTMatrix * pMatrix = IORTMatrix::GetInstance() )
    {
        pMatrix -> TotalEnergyDeposit(); 
        pMatrix -> StoreDoseFluenceAscii(newValue);
#ifdef G4ANALYSIS_USE_ROOT
        pMatrix -> StoreDoseFluenceRoot();
        IORTAnalysisManager::GetInstance() -> flush();     // Finalize & write the root file 
#endif
    }
    }
#ifdef G4ANALYSIS_USE_ROOT
    else if (command == FileNameCmd)
    {
    AnalysisManager->SetAnalysisFileName(newValue);
    IORTAnalysisManager::GetInstance() -> book(); // Book for a new ROOT TFile 
    }
#endif
}

---

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

• IORTAnalysisFileMessenger.hh
• IORTAnalysisFileMessenger.cc