G4LocalThreadCoutMessenger Class Reference

#include <G4LocalThreadCoutMessenger.hh>

Inheritance diagram for G4LocalThreadCoutMessenger:

Collaboration diagram for G4LocalThreadCoutMessenger:

Public Member Functions
	G4LocalThreadCoutMessenger ()
	~G4LocalThreadCoutMessenger ()
void	SetNewValue (G4UIcommand *, G4String)
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
G4UIdirectory *	coutDir
G4UIcommand *	coutFileNameCmd
G4UIcommand *	cerrFileNameCmd
G4UIcmdWithABool *	bufferCoutCmd
G4UIcmdWithAString *	prefixCmd
G4UIcmdWithAnInteger *	ignoreCmd
G4UIcmdWithABool *	ignoreInitCmd

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

Definition at line 48 of file G4LocalThreadCoutMessenger.hh.

Constructor & Destructor Documentation

G4LocalThreadCoutMessenger()

G4LocalThreadCoutMessenger::G4LocalThreadCoutMessenger

(

)

Definition at line 43 of file G4LocalThreadCoutMessenger.cc.

{ 
  coutDir = new G4UIdirectory("/control/cout/");
  coutDir->SetGuidance("Control cout/cerr for local thread.");

  coutFileNameCmd = new G4UIcommand("/control/cout/setCoutFile",this);
  coutFileNameCmd->SetGuidance("Send G4cout stream to a file dedicated to a thread. ");
  coutFileNameCmd->SetGuidance("To have a display output, use special keyword \"**Screen**\".");
  coutFileNameCmd->SetGuidance("If append flag is true output is appended to file,");
  coutFileNameCmd->SetGuidance("otherwise file output is overwritten.");
  coutFileNameCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  G4UIparameter* pp = new G4UIparameter("fileName",'s',true);
  pp->SetDefaultValue("**Screen**");
  coutFileNameCmd->SetParameter(pp);
  pp= new G4UIparameter("append",'b',true);
  pp->SetDefaultValue(true);
  coutFileNameCmd->SetParameter(pp);

  cerrFileNameCmd = new G4UIcommand("/control/cout/setCerrFile",this);
  cerrFileNameCmd->SetGuidance("Send G4cerr stream to a file dedicated to a thread. ");
  cerrFileNameCmd->SetGuidance("To have a display output, use special keyword \"**Screen**\".");
  cerrFileNameCmd->SetGuidance("If append flag is true output is appended to file,");
  cerrFileNameCmd->SetGuidance("otherwise file output is overwritten.");
  cerrFileNameCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  pp = new G4UIparameter("fileName",'s',true);
  pp->SetDefaultValue("**Screen**");
  cerrFileNameCmd->SetParameter(pp);
  pp= new G4UIparameter("append",'b',true);
  pp->SetDefaultValue(true);
  cerrFileNameCmd->SetParameter(pp);

  bufferCoutCmd = new G4UIcmdWithABool("/control/cout/useBuffer",this);
  bufferCoutCmd->SetGuidance("Send cout and/or cerr stream to a buffer.");
  bufferCoutCmd->SetGuidance("The buffered text will be printed at the end of the job");
  bufferCoutCmd->SetGuidance("for each thread at a time, so that output of each thread is grouped.");
  bufferCoutCmd->SetGuidance("This command has no effect if output goes to a file.");
  bufferCoutCmd->SetParameterName("flag",true);
  bufferCoutCmd->SetDefaultValue(true);
  bufferCoutCmd->AvailableForStates(G4State_PreInit,G4State_Idle);

  prefixCmd = new G4UIcmdWithAString("/control/cout/prefixString",this);
  prefixCmd->SetGuidance("Set the prefix string for each cout/cerr line from a thread.");
  prefixCmd->SetParameterName("prefix",true);
  prefixCmd->SetDefaultValue("G4WT");
  prefixCmd->AvailableForStates(G4State_PreInit,G4State_Idle);

  ignoreCmd = new G4UIcmdWithAnInteger("/control/cout/ignoreThreadsExcept",this);
  ignoreCmd->SetGuidance("Omit cout from threads except the specified one.");
  ignoreCmd->SetGuidance("This command takes effect only if cout destination is screen without buffering.");
  ignoreCmd->SetGuidance("If specified thread ID is greater than the number of threads,");
  ignoreCmd->SetGuidance("no cout is displayed from worker threads. -1 to reset.");
  ignoreCmd->SetGuidance("This command does not affect to cerr.");
  ignoreCmd->SetParameterName("threadID",true);
  ignoreCmd->SetDefaultValue(0);
  ignoreCmd->AvailableForStates(G4State_PreInit,G4State_Idle);

  ignoreInitCmd = new G4UIcmdWithABool("/control/cout/ignoreInitializationCout",this);
  ignoreInitCmd->SetGuidance("Omit cout from threads during initialization, as they should be identical to the masther thread.");
  ignoreInitCmd->SetGuidance("This command takes effect only if cout destination is screen without buffering.");
  ignoreInitCmd->SetGuidance("This command does not affect to cerr.");
  ignoreInitCmd->SetParameterName("IgnoreInit",true);
  ignoreInitCmd->SetDefaultValue(true);
  ignoreInitCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
}

Here is the call graph for this function:

~G4LocalThreadCoutMessenger()

G4LocalThreadCoutMessenger::~G4LocalThreadCoutMessenger

(

)

Definition at line 108 of file G4LocalThreadCoutMessenger.cc.

{
  delete coutFileNameCmd;
  delete cerrFileNameCmd;
  delete bufferCoutCmd;
  delete prefixCmd;
  delete ignoreCmd;
  delete ignoreInitCmd;
  delete coutDir;
}

Member Function Documentation

SetNewValue()

void G4LocalThreadCoutMessenger::SetNewValue ( G4UIcommand *  command, G4String  newVal  )

virtual

Reimplemented from G4UImessenger.

Definition at line 119 of file G4LocalThreadCoutMessenger.cc.

{  
  G4UImanager * UI = G4UImanager::GetUIpointer();
  if(command == coutFileNameCmd)
  {
    G4Tokenizer next(newVal);
    G4String fn = next();
    G4bool af = StoB(next());
    UI->SetCoutFileName(fn,af);
  }
  else if(command == cerrFileNameCmd)
  {
    G4Tokenizer next(newVal);
    G4String fn = next();
    G4bool af = StoB(next());
    UI->SetCerrFileName(fn,af);
  }
  else if(command == bufferCoutCmd)
  { UI->SetThreadUseBuffer(StoB(newVal)); }
  else if(command == prefixCmd)
  { UI->SetThreadPrefixString(newVal); }
  else if(command == ignoreCmd)
  { UI->SetThreadIgnore(StoI(newVal)); }
  else if(command == ignoreInitCmd)
  { UI->SetThreadIgnoreInit(StoB(newVal)); }
}

Here is the call graph for this function:

Member Data Documentation

bufferCoutCmd

G4UIcmdWithABool* G4LocalThreadCoutMessenger::bufferCoutCmd

private

Definition at line 60 of file G4LocalThreadCoutMessenger.hh.

cerrFileNameCmd

G4UIcommand* G4LocalThreadCoutMessenger::cerrFileNameCmd

private

Definition at line 59 of file G4LocalThreadCoutMessenger.hh.

coutDir

G4UIdirectory* G4LocalThreadCoutMessenger::coutDir

private

Definition at line 57 of file G4LocalThreadCoutMessenger.hh.

coutFileNameCmd

G4UIcommand* G4LocalThreadCoutMessenger::coutFileNameCmd

private

Definition at line 58 of file G4LocalThreadCoutMessenger.hh.

ignoreCmd

G4UIcmdWithAnInteger* G4LocalThreadCoutMessenger::ignoreCmd

private

Definition at line 62 of file G4LocalThreadCoutMessenger.hh.

ignoreInitCmd

G4UIcmdWithABool* G4LocalThreadCoutMessenger::ignoreInitCmd

private

Definition at line 63 of file G4LocalThreadCoutMessenger.hh.

prefixCmd

G4UIcmdWithAString* G4LocalThreadCoutMessenger::prefixCmd

private

Definition at line 61 of file G4LocalThreadCoutMessenger.hh.

---

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

• G4LocalThreadCoutMessenger.hh
• G4LocalThreadCoutMessenger.cc