G4GMocrenMessenger Class Reference

#include <G4GMocrenMessenger.hh>

Inheritance diagram for G4GMocrenMessenger:

Collaboration diagram for G4GMocrenMessenger:

Public Member Functions
	G4GMocrenMessenger ()
virtual	~G4GMocrenMessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
virtual G4String	getEventNumberSuffix ()
virtual G4bool	appendGeometry ()
virtual G4bool	addPointAttributes ()
virtual G4bool	useSolids ()
virtual G4bool	writeInvisibles ()
virtual G4String	getVolumeName ()
virtual std::vector< G4String >	getHitNames ()
virtual G4String	getScoringMeshName ()
virtual std::vector< G4String >	getHitScorerNames ()
virtual void	list ()
virtual void	getNoVoxels (G4int &nx, G4int &ny, G4int &nz) const
virtual G4bool	getDrawVolumeGrid ()
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Private Attributes
G4UIdirectory *	kgMocrenDirectory
G4String	suffix
G4UIcmdWithAString *	setEventNumberSuffixCommand
G4bool	geometry
G4UIcmdWithABool *	appendGeometryCommand
G4bool	pointAttributes
G4UIcmdWithABool *	addPointAttributesCommand
G4bool	solids
G4UIcmdWithABool *	useSolidsCommand
G4bool	invisibles
G4String	kgMocrenVolumeName
G4UIcmdWithAString *	kSetgMocrenVolumeNameCommand
std::vector< G4String >	kgMocrenHitNames
G4UIcmdWithAString *	kAddgMocrenHitNameCommand
G4UIcmdWithoutParameter *	kResetgMocrenHitNameCommand
G4String	kgMocrenScoringMeshName
G4UIcmdWithAString *	kSetgMocrenScoringMeshNameCommand
std::vector< G4String >	kgMocrenHitScorerNames
G4UIcmdWithAString *	kAddgMocrenHitScorerNameCommand
G4UIcmdWithoutParameter *	kResetgMocrenHitScorerNameCommand
G4int	kgMocrenNoVoxels [3]
G4UIcommand *	kSetgMocrenNoVoxelsCommand
G4UIcmdWithoutParameter *	kListgMocrenCommand
G4bool	kDrawVolumeGrid
G4UIcmdWithABool *	kDrawVolumeGridCommand

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 46 of file G4GMocrenMessenger.hh.

Constructor & Destructor Documentation

G4GMocrenMessenger()

G4GMocrenMessenger::G4GMocrenMessenger

(

)

Definition at line 41 of file G4GMocrenMessenger.cc.

  : suffix (""), geometry(true), pointAttributes(false), solids(true), invisibles(true),
    kgMocrenVolumeName("gMocrenVolume"),
    kgMocrenScoringMeshName("gMocrenScoringMesh"),
    kDrawVolumeGrid(false) {

  kgMocrenDirectory = new G4UIdirectory("/vis/gMocren/");
  kgMocrenDirectory->SetGuidance("gMocren commands.");

  setEventNumberSuffixCommand = new G4UIcmdWithAString("/vis/gMocren/setEventNumberSuffix", this);
  setEventNumberSuffixCommand->SetGuidance("Write separate event files, appended with given suffix.");
  setEventNumberSuffixCommand->SetGuidance("Define the suffix with a pattern such as '-0000'.");
  setEventNumberSuffixCommand->SetParameterName("suffix",false);
  setEventNumberSuffixCommand->SetDefaultValue("");
  setEventNumberSuffixCommand->AvailableForStates(G4State_Idle);
    
  appendGeometryCommand = new G4UIcmdWithABool("/vis/gMocren/appendGeometry", this);
  appendGeometryCommand->SetGuidance("Appends copy of geometry to every event.");
  appendGeometryCommand->SetParameterName("flag",false);
  appendGeometryCommand->SetDefaultValue(true);
  appendGeometryCommand->AvailableForStates(G4State_Idle);

  addPointAttributesCommand = new G4UIcmdWithABool("/vis/gMocren/addPointAttributes", this);
  addPointAttributesCommand->SetGuidance("Adds point attributes to the points of trajectories.");
  addPointAttributesCommand->SetParameterName("flag",false);
  addPointAttributesCommand->SetDefaultValue(false);
  addPointAttributesCommand->AvailableForStates(G4State_Idle);

  useSolidsCommand = new G4UIcmdWithABool("/vis/gMocren/useSolids", this);
  useSolidsCommand->SetGuidance("Use GMocren Solids, rather than Geant4 Primitives.");
  useSolidsCommand->SetParameterName("flag",false);
  useSolidsCommand->SetDefaultValue(true);
  useSolidsCommand->AvailableForStates(G4State_Idle);

  /* Not Enabled Yet
     writeInvisiblesCommand = new G4UIcmdWithABool("/vis/gMocren/writeInvisibles", this);
     writeInvisiblesCommand->SetGuidance("Write invisible objects.");
     writeInvisiblesCommand->SetParameterName("flag",false);
     writeInvisiblesCommand->SetDefaultValue(true);
     writeInvisiblesCommand->AvailableForStates(G4State_Idle);
  */

  kSetgMocrenVolumeNameCommand = new G4UIcmdWithAString("/vis/gMocren/setVolumeName", this);
  kSetgMocrenVolumeNameCommand->SetGuidance("detector name for a volume data in gMocren data.");
  kSetgMocrenVolumeNameCommand->SetParameterName("kgMocrenVolumeName",false);
  kSetgMocrenVolumeNameCommand->SetDefaultValue("gMocrenVolume");
  kSetgMocrenVolumeNameCommand->AvailableForStates(G4State_Idle);

  kAddgMocrenHitNameCommand = new G4UIcmdWithAString("/vis/gMocren/addHitName", this);
  kAddgMocrenHitNameCommand->SetGuidance("hit name for a dose distribution in gMocren data.");
  kAddgMocrenHitNameCommand->SetParameterName("kgMocrenHitName",false);
  kAddgMocrenHitNameCommand->AvailableForStates(G4State_Idle);

  kResetgMocrenHitNameCommand = new G4UIcmdWithoutParameter("/vis/gMocren/resetHitNames", this);
  kResetgMocrenHitNameCommand->SetGuidance("reset all hit names.");
  kResetgMocrenHitNameCommand->AvailableForStates(G4State_Idle);

  kSetgMocrenScoringMeshNameCommand = new G4UIcmdWithAString("/vis/gMocren/setScoringMeshName", this);
  kSetgMocrenScoringMeshNameCommand->SetGuidance("scoring mesh name for a dose distribution in gMocren data.");
  kSetgMocrenScoringMeshNameCommand->SetParameterName("kgMocrenScoringMeshName",false);
  kSetgMocrenScoringMeshNameCommand->SetDefaultValue("gMocrenScoringMesh");
  kSetgMocrenScoringMeshNameCommand->AvailableForStates(G4State_Idle);

  kAddgMocrenHitScorerNameCommand = new G4UIcmdWithAString("/vis/gMocren/addHitScorerName", this);
  kAddgMocrenHitScorerNameCommand->SetGuidance("hit scorer name for a dose distribution in gMocren data.");
  kAddgMocrenHitScorerNameCommand->SetParameterName("kgMocrenHitScorerNames",false);
  kAddgMocrenHitScorerNameCommand->AvailableForStates(G4State_Idle);

  kResetgMocrenHitScorerNameCommand = new G4UIcmdWithoutParameter("/vis/gMocren/resetHitScorerName", this);
  kResetgMocrenHitScorerNameCommand->SetGuidance("reset all hit scorer names.");
  kResetgMocrenHitScorerNameCommand->AvailableForStates(G4State_Idle);

  kSetgMocrenNoVoxelsCommand = new G4UIcommand("/vis/gMocren/setNumberOfVoxels", this);
  kSetgMocrenNoVoxelsCommand->SetGuidance("set number of voxels.");
  kSetgMocrenNoVoxelsCommand->AvailableForStates(G4State_Idle);
  G4UIparameter * param = new G4UIparameter("nX", 'i', false);
  param->SetDefaultValue("1");
  param->SetParameterRange("nX>0");
  kSetgMocrenNoVoxelsCommand->SetParameter(param);
  param = new G4UIparameter("nY", 'i', false);
  param->SetDefaultValue("1");
  param->SetParameterRange("nY>0");
  kSetgMocrenNoVoxelsCommand->SetParameter(param);
  param = new G4UIparameter("nZ", 'i', false);
  param->SetDefaultValue("1");
  param->SetParameterRange("nZ>0");
  kSetgMocrenNoVoxelsCommand->SetParameter(param);

  kListgMocrenCommand = new G4UIcmdWithoutParameter("/vis/gMocren/list", this);
  kListgMocrenCommand->SetGuidance("list gMocren command parameters.");
  kListgMocrenCommand->AvailableForStates(G4State_Idle);

  kDrawVolumeGridCommand = new G4UIcmdWithABool("/vis/gMocren/drawVolumeGrid", this);
  kDrawVolumeGridCommand->SetGuidance("Add grid of the volume.");
  kDrawVolumeGridCommand->SetParameterName("kDrawVolumeGrid",false);
  kDrawVolumeGridCommand->SetDefaultValue(false);
  kDrawVolumeGridCommand->AvailableForStates(G4State_Idle);

}

Here is the call graph for this function:

~G4GMocrenMessenger()

G4GMocrenMessenger::~G4GMocrenMessenger ( )

virtual

Definition at line 141 of file G4GMocrenMessenger.cc.

                                        {
  delete setEventNumberSuffixCommand;
  delete appendGeometryCommand;
  delete addPointAttributesCommand;
  delete useSolidsCommand;
  //    delete writeInvisiblesCommand;
  delete kSetgMocrenVolumeNameCommand;
  delete kAddgMocrenHitNameCommand;
  delete kResetgMocrenHitNameCommand;
  //
  delete kSetgMocrenScoringMeshNameCommand;
  delete kAddgMocrenHitScorerNameCommand;
  delete kResetgMocrenHitScorerNameCommand;
  //
  delete kSetgMocrenNoVoxelsCommand;
  //
  delete kgMocrenDirectory;
  //
  delete kDrawVolumeGridCommand;
}

Member Function Documentation

addPointAttributes()

G4bool G4GMocrenMessenger::addPointAttributes ( )

virtual

Definition at line 243 of file G4GMocrenMessenger.cc.

                                              {
  return pointAttributes;
}

appendGeometry()

G4bool G4GMocrenMessenger::appendGeometry ( )

virtual

Definition at line 239 of file G4GMocrenMessenger.cc.

                                          {
  return geometry;
}

GetCurrentValue()

G4String G4GMocrenMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 162 of file G4GMocrenMessenger.cc.

                                                                  {
  if (command==setEventNumberSuffixCommand) {
    return suffix;
  } else if (command==appendGeometryCommand) {
    return appendGeometryCommand->ConvertToString(geometry); 
  } else if (command==addPointAttributesCommand) {
    return addPointAttributesCommand->ConvertToString(pointAttributes); 
  } else if (command==useSolidsCommand) {
    return useSolidsCommand->ConvertToString(solids);
    //    } else if (command==writeInvisiblesCommand) {
    //        return writeInvisiblesCommand->ConvertToString(invisibles);
  } else if (command == kSetgMocrenVolumeNameCommand) {
    return kgMocrenVolumeName;
  } else if (command == kAddgMocrenHitNameCommand) {
    G4String strval;
    std::vector<G4String>::iterator itr = kgMocrenHitNames.begin();
    for(; itr != kgMocrenHitNames.end(); itr++) {
      strval += *itr;
      strval += " ";
    }
    return strval;
  } else if (command == kSetgMocrenScoringMeshNameCommand) {
    return kgMocrenScoringMeshName;
  } else if (command == kAddgMocrenHitScorerNameCommand) {
    G4String strval;
    std::vector<G4String>::iterator itr = kgMocrenHitScorerNames.begin();
    for(; itr != kgMocrenHitScorerNames.end(); itr++) {
      strval += *itr;
      strval += " ";
    }
    return strval;
  } else if (command==kDrawVolumeGridCommand) {
    return kDrawVolumeGridCommand->ConvertToString(kDrawVolumeGrid);
  } else {
    return "";
  }
}

Here is the call graph for this function:

getDrawVolumeGrid()

virtual G4bool G4GMocrenMessenger::getDrawVolumeGrid ( )

inlinevirtual

Definition at line 66 of file G4GMocrenMessenger.hh.

{return kDrawVolumeGrid;}

Here is the caller graph for this function:

getEventNumberSuffix()

G4String G4GMocrenMessenger::getEventNumberSuffix ( )

virtual

Definition at line 235 of file G4GMocrenMessenger.cc.

                                                  {
  return suffix;
}

getHitNames()

std::vector< G4String > G4GMocrenMessenger::getHitNames ( )

virtual

Definition at line 259 of file G4GMocrenMessenger.cc.

                                                    {
  return kgMocrenHitNames;
}

Here is the caller graph for this function:

getHitScorerNames()

std::vector< G4String > G4GMocrenMessenger::getHitScorerNames ( )

virtual

Definition at line 267 of file G4GMocrenMessenger.cc.

                                                          {
  return kgMocrenHitScorerNames;
}

Here is the caller graph for this function:

getNoVoxels()

void G4GMocrenMessenger::getNoVoxels ( G4int &  nx, G4int &  ny, G4int &  nz  ) const

virtual

Definition at line 298 of file G4GMocrenMessenger.cc.

                                                                             {
  nx = kgMocrenNoVoxels[0];
  ny = kgMocrenNoVoxels[1];
  nz = kgMocrenNoVoxels[2];
}

getScoringMeshName()

G4String G4GMocrenMessenger::getScoringMeshName ( )

virtual

Definition at line 263 of file G4GMocrenMessenger.cc.

                                                {
  return kgMocrenScoringMeshName;
}

getVolumeName()

G4String G4GMocrenMessenger::getVolumeName ( )

virtual

Definition at line 255 of file G4GMocrenMessenger.cc.

                                           {
  return kgMocrenVolumeName;
}

Here is the caller graph for this function:

list()

void G4GMocrenMessenger::list ( )

virtual

Definition at line 271 of file G4GMocrenMessenger.cc.

                              {
  G4cout << "  Current valuess of gMocren command parameters:" << G4endl;
  //
  G4cout << "    volume name:        " << kgMocrenVolumeName << G4endl;
  //
  G4cout << "    hit names:          ";
  if(kgMocrenHitNames.size() > 0) {
    std::vector<G4String>::iterator itr = kgMocrenHitNames.begin();
    for(; itr != kgMocrenHitNames.end(); itr++)
      G4cout << *itr << "  " << G4endl;
  } else {
    G4cout << G4endl;
  }
  //
  G4cout << "    scoring mesh name:  " << kgMocrenScoringMeshName << G4endl;
  //
  G4cout << "    scorer names:       ";
  if(kgMocrenHitScorerNames.size() > 0) {
    std::vector<G4String>::iterator itr = kgMocrenHitScorerNames.begin();
    for(; itr != kgMocrenHitScorerNames.end(); itr++)
      G4cout << *itr << "  " << G4endl;
  } else {
    G4cout << G4endl;
  }
  G4cout << G4endl;
}

Here is the caller graph for this function:

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 200 of file G4GMocrenMessenger.cc.

                                                                             {
  if (command==setEventNumberSuffixCommand) {
    suffix = newValue;
  } else if (command==appendGeometryCommand) {
    geometry = appendGeometryCommand->GetNewBoolValue(newValue);
  } else if (command==addPointAttributesCommand) {
    pointAttributes = addPointAttributesCommand->GetNewBoolValue(newValue);
  } else if (command==useSolidsCommand) {
    solids = useSolidsCommand->GetNewBoolValue(newValue);
    //    } else if (command==writeInvisiblesCommand) {
    //        invisibles = writeInvisiblesCommand->GetNewBoolValue(newValue);
  } else if (command == kSetgMocrenVolumeNameCommand) {
    kgMocrenVolumeName = newValue;
  } else if (command == kAddgMocrenHitNameCommand) {
    kgMocrenHitNames.push_back(newValue);
  } else if (command == kResetgMocrenHitNameCommand) {
    kgMocrenHitNames.clear();
  } else if (command == kSetgMocrenScoringMeshNameCommand) {
    kgMocrenScoringMeshName = newValue;
  } else if (command == kAddgMocrenHitScorerNameCommand) {
    kgMocrenHitScorerNames.push_back(newValue);
  } else if (command == kResetgMocrenHitScorerNameCommand) {
    kgMocrenHitScorerNames.clear();
  } else if (command == kListgMocrenCommand) {
    list();
  } else if (command == kSetgMocrenNoVoxelsCommand) {
    G4Tokenizer next(newValue);
    for(int i = 0; i < 3; i++) {
      kgMocrenNoVoxels[i] = StoI(next());
    }
  } else if (command==kDrawVolumeGridCommand) {
    kDrawVolumeGrid = kDrawVolumeGridCommand->GetNewBoolValue(newValue);
  } 
}

Here is the call graph for this function:

useSolids()

G4bool G4GMocrenMessenger::useSolids ( )

virtual

Definition at line 247 of file G4GMocrenMessenger.cc.

                                     {
  return solids;
}

writeInvisibles()

G4bool G4GMocrenMessenger::writeInvisibles ( )

virtual

Definition at line 251 of file G4GMocrenMessenger.cc.

                                           {
  return invisibles;
}

Member Data Documentation

addPointAttributesCommand

G4UIcmdWithABool* G4GMocrenMessenger::addPointAttributesCommand

private

Definition at line 78 of file G4GMocrenMessenger.hh.

appendGeometryCommand

G4UIcmdWithABool* G4GMocrenMessenger::appendGeometryCommand

private

Definition at line 75 of file G4GMocrenMessenger.hh.

geometry

G4bool G4GMocrenMessenger::geometry

private

Definition at line 74 of file G4GMocrenMessenger.hh.

invisibles

G4bool G4GMocrenMessenger::invisibles

private

Definition at line 83 of file G4GMocrenMessenger.hh.

kAddgMocrenHitNameCommand

G4UIcmdWithAString* G4GMocrenMessenger::kAddgMocrenHitNameCommand

private

Definition at line 89 of file G4GMocrenMessenger.hh.

kAddgMocrenHitScorerNameCommand

G4UIcmdWithAString* G4GMocrenMessenger::kAddgMocrenHitScorerNameCommand

private

Definition at line 96 of file G4GMocrenMessenger.hh.

kDrawVolumeGrid

G4bool G4GMocrenMessenger::kDrawVolumeGrid

private

Definition at line 104 of file G4GMocrenMessenger.hh.

kDrawVolumeGridCommand

G4UIcmdWithABool* G4GMocrenMessenger::kDrawVolumeGridCommand

private

Definition at line 105 of file G4GMocrenMessenger.hh.

kgMocrenDirectory

G4UIdirectory* G4GMocrenMessenger::kgMocrenDirectory

private

Definition at line 69 of file G4GMocrenMessenger.hh.

kgMocrenHitNames

std::vector<G4String> G4GMocrenMessenger::kgMocrenHitNames

private

Definition at line 88 of file G4GMocrenMessenger.hh.

kgMocrenHitScorerNames

std::vector<G4String> G4GMocrenMessenger::kgMocrenHitScorerNames

private

Definition at line 95 of file G4GMocrenMessenger.hh.

kgMocrenNoVoxels

G4int G4GMocrenMessenger::kgMocrenNoVoxels[3]

private

Definition at line 99 of file G4GMocrenMessenger.hh.

kgMocrenScoringMeshName

G4String G4GMocrenMessenger::kgMocrenScoringMeshName

private

Definition at line 92 of file G4GMocrenMessenger.hh.

kgMocrenVolumeName

G4String G4GMocrenMessenger::kgMocrenVolumeName

private

Definition at line 85 of file G4GMocrenMessenger.hh.

kListgMocrenCommand

G4UIcmdWithoutParameter* G4GMocrenMessenger::kListgMocrenCommand

private

Definition at line 102 of file G4GMocrenMessenger.hh.

kResetgMocrenHitNameCommand

G4UIcmdWithoutParameter* G4GMocrenMessenger::kResetgMocrenHitNameCommand

private

Definition at line 90 of file G4GMocrenMessenger.hh.

kResetgMocrenHitScorerNameCommand

G4UIcmdWithoutParameter* G4GMocrenMessenger::kResetgMocrenHitScorerNameCommand

private

Definition at line 97 of file G4GMocrenMessenger.hh.

kSetgMocrenNoVoxelsCommand

G4UIcommand* G4GMocrenMessenger::kSetgMocrenNoVoxelsCommand

private

Definition at line 100 of file G4GMocrenMessenger.hh.

kSetgMocrenScoringMeshNameCommand

G4UIcmdWithAString* G4GMocrenMessenger::kSetgMocrenScoringMeshNameCommand

private

Definition at line 93 of file G4GMocrenMessenger.hh.

kSetgMocrenVolumeNameCommand

G4UIcmdWithAString* G4GMocrenMessenger::kSetgMocrenVolumeNameCommand

private

Definition at line 86 of file G4GMocrenMessenger.hh.

pointAttributes

G4bool G4GMocrenMessenger::pointAttributes

private

Definition at line 77 of file G4GMocrenMessenger.hh.

setEventNumberSuffixCommand

G4UIcmdWithAString* G4GMocrenMessenger::setEventNumberSuffixCommand

private

Definition at line 72 of file G4GMocrenMessenger.hh.

solids

G4bool G4GMocrenMessenger::solids

private

Definition at line 80 of file G4GMocrenMessenger.hh.

suffix

G4String G4GMocrenMessenger::suffix

private

Definition at line 71 of file G4GMocrenMessenger.hh.

useSolidsCommand

G4UIcmdWithABool* G4GMocrenMessenger::useSolidsCommand

private

Definition at line 81 of file G4GMocrenMessenger.hh.

---

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

• G4GMocrenMessenger.hh
• G4GMocrenMessenger.cc