G4ASCIITreeMessenger Class Reference

#include <G4ASCIITreeMessenger.hh>

Inheritance diagram for G4ASCIITreeMessenger:

Public Member Functions
	G4ASCIITreeMessenger (G4ASCIITree *)
virtual	~G4ASCIITreeMessenger ()
G4String	GetCurrentValue (G4UIcommand *command)
void	SetNewValue (G4UIcommand *command, G4String newValue)
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()=default
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	CommandsShouldBeInMaster () const

Static Public Attributes
static std::vector< G4String >	fVerbosityGuidance

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	LtoS (G4long l)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (const G4String &s)
G4long	StoL (const G4String &s)
G4double	StoD (const 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 = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false

Detailed Description

Definition at line 46 of file G4ASCIITreeMessenger.hh.

Constructor & Destructor Documentation

G4ASCIITreeMessenger()

G4ASCIITreeMessenger::G4ASCIITreeMessenger

(

G4ASCIITree *

ASCIITree

)

Definition at line 43 of file G4ASCIITreeMessenger.cc.

                        :
fpASCIITree(ASCIITree) {
 
  G4bool omitable;
 
  fpDirectory = new G4UIdirectory ("/vis/ASCIITree/");
  fpDirectory -> SetGuidance ("Commands for ASCIITree control.");
 
  fpDirectorySet = new G4UIdirectory ("/vis/ASCIITree/set/");
  fpDirectorySet -> SetGuidance ("Settings for ASCIITree control.");
 
  fpCommandVerbose = new G4UIcmdWithAnInteger ("/vis/ASCIITree/verbose", this);
  fVerbosityGuidance.push_back
    ("  <  10: notifies but does not print details of repeated volumes.");
  fVerbosityGuidance.push_back
    ("  >= 10: prints all physical volumes (touchables).");
  fVerbosityGuidance.push_back
    ("The level of detail is given by verbosity%10:");
  fVerbosityGuidance.push_back
    ("  >=  0: physical volume name.");
  fVerbosityGuidance.push_back
    ("  >=  1: logical volume name (and names of sensitive detector"
     " and readout geometry, if any).");
  fVerbosityGuidance.push_back
    ("  >=  2: solid name and type.");
  fVerbosityGuidance.push_back
    ("  >=  3: volume and density.");
  fVerbosityGuidance.push_back
    ("  >=  5: daughter-subtracted volume and mass.");
  fVerbosityGuidance.push_back
    ("  >=  6: physical volume dump.");
  fVerbosityGuidance.push_back
    ("  >=  7: polyhedron dump.");
  fVerbosityGuidance.push_back
    ("and in the summary at the end of printing:");
  fVerbosityGuidance.push_back
    ("  >=  4: daughter-included mass of top physical volume(s) in scene"
     " to depth specified.");
  fVerbosityGuidance.push_back
    ("Note: by default, culling is switched off so all volumes are seen.");
  fVerbosityGuidance.push_back
    ("Note: the mass calculation takes into account daughters, which can be"
     " time consuming.  If you want the mass of a particular subtree try:");
  fVerbosityGuidance.push_back
    ("  /vis/drawTree <subtree-physical-volume-name>");
  fVerbosityGuidance.push_back
    ("Or if you want more control, for example:");
  fVerbosityGuidance.push_back
    ("  /vis/open ATree");
  fVerbosityGuidance.push_back
    ("  /vis/ASCIITree/verbose 14");
  fVerbosityGuidance.push_back
    ("  /vis/scene/create");
  fVerbosityGuidance.push_back
    ("  /vis/scene/add/volume <subtree-physical-volume-name> ! <depth>");
  fVerbosityGuidance.push_back
    ("  /vis/sceneHandler/attach");
  fVerbosityGuidance.push_back
    ("  /vis/viewer/flush");
  fVerbosityGuidance.push_back
    ("Note: dumping the physical volumes produces a lot of output. It is"
     " advisable to select the volume of interest, as for a sub-tree above.");
  for (size_t i = 0; i < fVerbosityGuidance.size(); ++i) {
    fpCommandVerbose -> SetGuidance(fVerbosityGuidance[i]);
  }
  fpCommandVerbose -> SetParameterName ("verbosity",omitable = true);
  fpCommandVerbose -> SetDefaultValue(1);
 
  fpCommandSetOutFile = new G4UIcmdWithAString ("/vis/ASCIITree/set/outFile", this
);
  fpCommandSetOutFile -> SetGuidance ("Set name of output file.");
  fpCommandSetOutFile -> SetParameterName ("out-filename",
                       omitable = true);
  fpCommandSetOutFile -> SetDefaultValue ("G4cout");
}

~G4ASCIITreeMessenger()

G4ASCIITreeMessenger::~G4ASCIITreeMessenger ( )

virtual

Definition at line 120 of file G4ASCIITreeMessenger.cc.

                                            {
  delete fpCommandSetOutFile;
  delete fpDirectorySet;
  delete fpCommandVerbose;
  delete fpDirectory;
}

Member Function Documentation

GetCurrentValue()

G4String G4ASCIITreeMessenger::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 127 of file G4ASCIITreeMessenger.cc.

                                                           {
  return "";
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 131 of file G4ASCIITreeMessenger.cc.

                    {
  if (command == fpCommandVerbose)
    {
      fpASCIITree->SetVerbosity
    (fpCommandVerbose->GetNewIntValue(newValue));
      G4cout << "G4ASCIITree verbosity now "
         << fpASCIITree->GetVerbosity()
         << G4endl;
    }
  else if (command == fpCommandSetOutFile)
    {
      fpASCIITree -> SetOutFileName (newValue);      
      G4cout << "G4ASCIITree out filename now "
             << fpASCIITree -> GetOutFileName()
             << G4endl;  
    }
}

Member Data Documentation

fVerbosityGuidance

std::vector< G4String > G4ASCIITreeMessenger::fVerbosityGuidance

static

Definition at line 52 of file G4ASCIITreeMessenger.hh.

Referenced by G4ASCIITreeMessenger(), and G4ASCIITreeSceneHandler::WriteHeader().

---

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

• G4ASCIITreeMessenger.hh
• G4ASCIITreeMessenger.cc