G4HepRepMessenger Class Reference

#include <G4HepRepMessenger.hh>

Inheritance diagram for G4HepRepMessenger:

Collaboration diagram for G4HepRepMessenger:

Public Member Functions
virtual	~G4HepRepMessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
virtual G4String	getFileDir ()
virtual G4String	getFileName ()
virtual G4bool	getOverwrite ()
virtual G4bool	getCullInvisibles ()
virtual G4bool	renderCylAsPolygons ()
virtual G4double	getScale ()
virtual G4ThreeVector	getCenter ()
virtual G4String	getEventNumberSuffix ()
virtual G4bool	appendGeometry ()
virtual G4bool	addPointAttributes ()
virtual G4bool	useSolids ()
virtual G4bool	writeInvisibles ()
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

Static Public Member Functions
static G4HepRepMessenger *	GetInstance ()

Private Member Functions
	G4HepRepMessenger ()

Private Attributes
G4UIdirectory *	heprepDirectory
G4String	fileDir
G4UIcmdWithAString *	setFileDirCommand
G4String	fileName
G4UIcmdWithAString *	setFileNameCommand
G4bool	overwrite
G4UIcmdWithABool *	setOverwriteCommand
G4bool	cullInvisibles
G4UIcmdWithABool *	setCullInvisiblesCommand
G4bool	cylAsPolygons
G4UIcmdWithABool *	renderCylAsPolygonsCommand
G4double	scale
G4UIcmdWithADouble *	setScaleCommand
G4ThreeVector	center
G4UIcmdWith3VectorAndUnit *	setCenterCommand
G4String	suffix
G4UIcmdWithAString *	setEventNumberSuffixCommand
G4bool	geometry
G4UIcmdWithABool *	appendGeometryCommand
G4bool	pointAttributes
G4UIcmdWithABool *	addPointAttributesCommand
G4bool	solids
G4UIcmdWithABool *	useSolidsCommand
G4bool	invisibles

Static Private Attributes
static G4HepRepMessenger *	fpInstance = 0

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 41 of file G4HepRepMessenger.hh.

Constructor & Destructor Documentation

~G4HepRepMessenger()

G4HepRepMessenger::~G4HepRepMessenger ( )

virtual

Definition at line 153 of file G4HepRepMessenger.cc.

                                      {
    delete setFileDirCommand;
    delete setFileNameCommand;
    delete setOverwriteCommand;
    delete setCullInvisiblesCommand;
    delete renderCylAsPolygonsCommand;
    delete setScaleCommand;
    delete setCenterCommand;
    delete setEventNumberSuffixCommand;
    delete appendGeometryCommand;
    delete addPointAttributesCommand;
    delete useSolidsCommand;
    delete heprepDirectory;
}

G4HepRepMessenger()

G4HepRepMessenger::G4HepRepMessenger ( )

private

Definition at line 40 of file G4HepRepMessenger.cc.

                                     :
    fileDir(""),
    fileName("G4Data"),
    overwrite(false),
    cullInvisibles(false),
    cylAsPolygons(false),
    scale(1.),
    suffix (""),
    geometry(true),
    solids(true),
    invisibles(true) {

    heprepDirectory = new G4UIdirectory("/vis/heprep/");
    heprepDirectory->SetGuidance("HepRep commands.");
        
    setFileDirCommand = new G4UIcmdWithAString("/vis/heprep/setFileDir", this);
    setFileDirCommand->SetGuidance("Set directory for output.");
    setFileDirCommand->SetGuidance("This command is used by HepRepFile, not by HepRepXML.");
    setFileDirCommand->SetParameterName("directory",false);
    if ( getenv( "G4HEPREPFILE_DIR" ) == NULL ) {
        setFileDirCommand->SetDefaultValue("");
    } else {
        setFileDirCommand->SetDefaultValue(getenv("G4HEPREPFILE_DIR"));
        fileDir = getenv("G4HEPREPFILE_DIR");
    }
    setFileDirCommand->AvailableForStates(G4State_Idle);
        
    setFileNameCommand = new G4UIcmdWithAString("/vis/heprep/setFileName", this);
    setFileNameCommand->SetGuidance("Set file name for output.");
    setFileNameCommand->SetGuidance("This command is used by HepRepFile, not by HepRepXML.");
    setFileNameCommand->SetParameterName("directory",false);
    if ( getenv( "G4HEPREPFILE_NAME" ) == NULL ) {
        setFileNameCommand->SetDefaultValue("G4Data");
    } else {
        setFileNameCommand->SetDefaultValue(getenv("G4HEPREPFILE_NAME"));
        fileName = getenv("G4HEPREPFILE_NAME");
    }
    setFileNameCommand->AvailableForStates(G4State_Idle);

    setOverwriteCommand = new G4UIcmdWithABool("/vis/heprep/setOverwrite", this);
    setOverwriteCommand->SetGuidance("Set true to write all output to exact same file name.");
    setOverwriteCommand->SetGuidance("Set false to increment the file name for each new output.");
    setOverwriteCommand->SetGuidance("This command is used by HepRepFile, not by HepRepXML.");
    setOverwriteCommand->SetParameterName("flag",false);
    if ( getenv( "G4HEPREPFILE_OVERWRITE" ) == NULL ) {
        setOverwriteCommand->SetDefaultValue(false);
    } else {
        setOverwriteCommand->SetDefaultValue(getenv("G4HEPREPFILE_OVERWRITE"));
        overwrite = setOverwriteCommand->ConvertToBool(getenv("G4HEPREPFILE_OVERWRITE"));
    }
    setOverwriteCommand->AvailableForStates(G4State_Idle);
        
    setCullInvisiblesCommand = new G4UIcmdWithABool("/vis/heprep/setCullInvisibles", this);
    setCullInvisiblesCommand->SetGuidance("Remove invisible objects from output file.");
    setCullInvisiblesCommand->SetGuidance("This command is used by HepRepFile, not by HepRepXML.");
    setCullInvisiblesCommand->SetParameterName("flag",false);
    if ( getenv( "G4HEPREPFILE_CULL" ) == NULL ) {
        setCullInvisiblesCommand->SetDefaultValue(false);
    } else {
        setCullInvisiblesCommand->SetDefaultValue(getenv("G4HEPREPFILE_CULL"));
        cullInvisibles = setCullInvisiblesCommand->ConvertToBool(getenv("G4HEPREPFILE_CULL"));
    }
    setCullInvisiblesCommand->AvailableForStates(G4State_Idle);
        
    renderCylAsPolygonsCommand = new G4UIcmdWithABool("/vis/heprep/renderCylAsPolygons", this);
    renderCylAsPolygonsCommand->SetGuidance("Render cylinders and cones as polygons.");
    renderCylAsPolygonsCommand->SetGuidance("This command is used by HepRepFile, not by HepRepXML.");
    renderCylAsPolygonsCommand->SetParameterName("flag",false);
    renderCylAsPolygonsCommand->SetDefaultValue(false);
    renderCylAsPolygonsCommand->AvailableForStates(G4State_Idle);
        
    setScaleCommand = new G4UIcmdWithADouble("/vis/heprep/scale",this);
    setScaleCommand->SetGuidance("Re-Scale coordinates.");
    setScaleCommand->SetParameterName("Scale",true);
    setScaleCommand->SetDefaultValue(1.);
    setScaleCommand->SetRange("Scale > 0");
    
    setCenterCommand = new G4UIcmdWith3VectorAndUnit("/vis/heprep/center",this);
    setCenterCommand->SetGuidance("Re-Center coordinates.");
    setCenterCommand->SetParameterName("CenterX","CenterY","CenterZ",true);
    setCenterCommand->SetDefaultValue(G4ThreeVector(0.,0.,0.));
    setCenterCommand->SetDefaultUnit("m");
        
    setEventNumberSuffixCommand = new G4UIcmdWithAString("/vis/heprep/setEventNumberSuffix", this);
    setEventNumberSuffixCommand->SetGuidance("Write separate event files, appended with given suffix.");
    setEventNumberSuffixCommand->SetGuidance("Define the suffix with a pattern such as '-0000'.");
    setEventNumberSuffixCommand->SetGuidance("This command is used by HepRepXML, not by HepRepFile.");
    setEventNumberSuffixCommand->SetParameterName("suffix",false);
    setEventNumberSuffixCommand->SetDefaultValue("");
    setEventNumberSuffixCommand->AvailableForStates(G4State_Idle);
    
    appendGeometryCommand = new G4UIcmdWithABool("/vis/heprep/appendGeometry", this);
    appendGeometryCommand->SetGuidance("Appends copy of geometry to every event.");
    appendGeometryCommand->SetGuidance("This command is used by HepRepXML, not by HepRepFile.");
    appendGeometryCommand->SetParameterName("flag",false);
    appendGeometryCommand->SetDefaultValue(true);
    appendGeometryCommand->AvailableForStates(G4State_Idle);

    addPointAttributesCommand = new G4UIcmdWithABool("/vis/heprep/addPointAttributes", this);
    addPointAttributesCommand->SetGuidance("Adds point attributes to the points of trajectories.");
    addPointAttributesCommand->SetGuidance("This command is used by HepRepXML, not by HepRepFile.");
    addPointAttributesCommand->SetParameterName("flag",false);
    addPointAttributesCommand->SetDefaultValue(false);
    addPointAttributesCommand->AvailableForStates(G4State_Idle);
        
    useSolidsCommand = new G4UIcmdWithABool("/vis/heprep/useSolids", this);
    useSolidsCommand->SetGuidance("Use HepRep Solids, rather than Geant4 Primitives.");
    useSolidsCommand->SetGuidance("This command is used by HepRepXML, not by HepRepFile..");
    useSolidsCommand->SetParameterName("flag",false);
    useSolidsCommand->SetDefaultValue(true);
    useSolidsCommand->AvailableForStates(G4State_Idle);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

addPointAttributes()

G4bool G4HepRepMessenger::addPointAttributes ( )

virtual

Definition at line 258 of file G4HepRepMessenger.cc.

                                             {
    return pointAttributes;
}

appendGeometry()

G4bool G4HepRepMessenger::appendGeometry ( )

virtual

Definition at line 254 of file G4HepRepMessenger.cc.

                                         {
    return geometry;
}

Here is the caller graph for this function:

getCenter()

G4ThreeVector G4HepRepMessenger::getCenter ( )

virtual

Definition at line 246 of file G4HepRepMessenger.cc.

                                           {
    return center;
}

Here is the caller graph for this function:

getCullInvisibles()

G4bool G4HepRepMessenger::getCullInvisibles ( )

virtual

Definition at line 234 of file G4HepRepMessenger.cc.

                                            {
    return cullInvisibles;
}

Here is the caller graph for this function:

GetCurrentValue()

G4String G4HepRepMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 168 of file G4HepRepMessenger.cc.

                                                                 {
    if (command==setFileDirCommand) {
        return fileDir;
    } else if (command==setFileNameCommand) {
        return fileName; 
    } else if (command==setOverwriteCommand) {
        return overwrite; 
    } else if (command==setCullInvisiblesCommand) {
        return cullInvisibles; 
    } else if (command==renderCylAsPolygonsCommand) {
        return renderCylAsPolygonsCommand->ConvertToString(cylAsPolygons);
    } else if (command==setScaleCommand) {
        return setScaleCommand->ConvertToString(scale);
    } else if (command==setCenterCommand) {
        return setCenterCommand->ConvertToString(center,"m");
    } else 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 {
        return "";
    }
}

Here is the call graph for this function:

getEventNumberSuffix()

G4String G4HepRepMessenger::getEventNumberSuffix ( )

virtual

Definition at line 250 of file G4HepRepMessenger.cc.

                                                 {
    return suffix;
}

Here is the caller graph for this function:

getFileDir()

G4String G4HepRepMessenger::getFileDir ( )

virtual

Definition at line 222 of file G4HepRepMessenger.cc.

                                       {
    return fileDir;
}

Here is the caller graph for this function:

getFileName()

G4String G4HepRepMessenger::getFileName ( )

virtual

Definition at line 226 of file G4HepRepMessenger.cc.

                                        {
    return fileName;
}

Here is the caller graph for this function:

GetInstance()

G4HepRepMessenger * G4HepRepMessenger::GetInstance ( void  )

static

Definition at line 34 of file G4HepRepMessenger.cc.

{
    if (!fpInstance) fpInstance = new G4HepRepMessenger;
    return fpInstance;
}

Here is the call graph for this function:

Here is the caller graph for this function:

getOverwrite()

G4bool G4HepRepMessenger::getOverwrite ( )

virtual

Definition at line 230 of file G4HepRepMessenger.cc.

                                       {
    return overwrite;
}

Here is the caller graph for this function:

getScale()

G4double G4HepRepMessenger::getScale ( )

virtual

Definition at line 242 of file G4HepRepMessenger.cc.

                                     {
    return scale;
}

Here is the caller graph for this function:

renderCylAsPolygons()

G4bool G4HepRepMessenger::renderCylAsPolygons ( )

virtual

Definition at line 238 of file G4HepRepMessenger.cc.

                                              {
    return cylAsPolygons;
}

Here is the caller graph for this function:

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 196 of file G4HepRepMessenger.cc.

                                                                            {
    if (command==setFileDirCommand) {
        fileDir = newValue;
    } else if (command==setFileNameCommand) {
        fileName = newValue;
    } else if (command==setOverwriteCommand) {
        overwrite = setOverwriteCommand->GetNewBoolValue(newValue);
    } else if (command==setCullInvisiblesCommand) {
        cullInvisibles = setCullInvisiblesCommand->GetNewBoolValue(newValue);
    } else if (command==renderCylAsPolygonsCommand) {
        cylAsPolygons = renderCylAsPolygonsCommand->GetNewBoolValue(newValue);
    } else if (command==setScaleCommand) {
        scale = setScaleCommand->GetNewDoubleValue(newValue);
    } else if (command==setCenterCommand) {
        center = setCenterCommand->GetNew3VectorValue(newValue);
    } else 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);
    } 
}

Here is the call graph for this function:

useSolids()

G4bool G4HepRepMessenger::useSolids ( )

virtual

Definition at line 262 of file G4HepRepMessenger.cc.

                                    {
    return solids;
}

Here is the caller graph for this function:

writeInvisibles()

G4bool G4HepRepMessenger::writeInvisibles ( )

virtual

Definition at line 266 of file G4HepRepMessenger.cc.

                                          {
    return invisibles;
}

Here is the caller graph for this function:

Member Data Documentation

addPointAttributesCommand

G4UIcmdWithABool* G4HepRepMessenger::addPointAttributesCommand

private

Definition at line 100 of file G4HepRepMessenger.hh.

appendGeometryCommand

G4UIcmdWithABool* G4HepRepMessenger::appendGeometryCommand

private

Definition at line 97 of file G4HepRepMessenger.hh.

center

G4ThreeVector G4HepRepMessenger::center

private

Definition at line 90 of file G4HepRepMessenger.hh.

cullInvisibles

G4bool G4HepRepMessenger::cullInvisibles

private

Definition at line 81 of file G4HepRepMessenger.hh.

cylAsPolygons

G4bool G4HepRepMessenger::cylAsPolygons

private

Definition at line 84 of file G4HepRepMessenger.hh.

fileDir

G4String G4HepRepMessenger::fileDir

private

Definition at line 72 of file G4HepRepMessenger.hh.

fileName

G4String G4HepRepMessenger::fileName

private

Definition at line 75 of file G4HepRepMessenger.hh.

fpInstance

G4HepRepMessenger * G4HepRepMessenger::fpInstance = 0

staticprivate

Definition at line 68 of file G4HepRepMessenger.hh.

geometry

G4bool G4HepRepMessenger::geometry

private

Definition at line 96 of file G4HepRepMessenger.hh.

heprepDirectory

G4UIdirectory* G4HepRepMessenger::heprepDirectory

private

Definition at line 70 of file G4HepRepMessenger.hh.

invisibles

G4bool G4HepRepMessenger::invisibles

private

Definition at line 105 of file G4HepRepMessenger.hh.

overwrite

G4bool G4HepRepMessenger::overwrite

private

Definition at line 78 of file G4HepRepMessenger.hh.

pointAttributes

G4bool G4HepRepMessenger::pointAttributes

private

Definition at line 99 of file G4HepRepMessenger.hh.

renderCylAsPolygonsCommand

G4UIcmdWithABool* G4HepRepMessenger::renderCylAsPolygonsCommand

private

Definition at line 85 of file G4HepRepMessenger.hh.

scale

G4double G4HepRepMessenger::scale

private

Definition at line 87 of file G4HepRepMessenger.hh.

setCenterCommand

G4UIcmdWith3VectorAndUnit* G4HepRepMessenger::setCenterCommand

private

Definition at line 91 of file G4HepRepMessenger.hh.

setCullInvisiblesCommand

G4UIcmdWithABool* G4HepRepMessenger::setCullInvisiblesCommand

private

Definition at line 82 of file G4HepRepMessenger.hh.

setEventNumberSuffixCommand

G4UIcmdWithAString* G4HepRepMessenger::setEventNumberSuffixCommand

private

Definition at line 94 of file G4HepRepMessenger.hh.

setFileDirCommand

G4UIcmdWithAString* G4HepRepMessenger::setFileDirCommand

private

Definition at line 73 of file G4HepRepMessenger.hh.

setFileNameCommand

G4UIcmdWithAString* G4HepRepMessenger::setFileNameCommand

private

Definition at line 76 of file G4HepRepMessenger.hh.

setOverwriteCommand

G4UIcmdWithABool* G4HepRepMessenger::setOverwriteCommand

private

Definition at line 79 of file G4HepRepMessenger.hh.

setScaleCommand

G4UIcmdWithADouble* G4HepRepMessenger::setScaleCommand

private

Definition at line 88 of file G4HepRepMessenger.hh.

solids

G4bool G4HepRepMessenger::solids

private

Definition at line 102 of file G4HepRepMessenger.hh.

suffix

G4String G4HepRepMessenger::suffix

private

Definition at line 93 of file G4HepRepMessenger.hh.

useSolidsCommand

G4UIcmdWithABool* G4HepRepMessenger::useSolidsCommand

private

Definition at line 103 of file G4HepRepMessenger.hh.

---

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

• G4HepRepMessenger.hh
• G4HepRepMessenger.cc