G4GeometryMessenger Class Reference

#include <G4GeometryMessenger.hh>

Inheritance diagram for G4GeometryMessenger:

Collaboration diagram for G4GeometryMessenger:

Public Member Functions
	G4GeometryMessenger (G4TransportationManager *tman)
	~G4GeometryMessenger ()
void	SetNewValue (G4UIcommand *command, G4String newValues)
G4String	GetCurrentValue (G4UIcommand *command)
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 Member Functions
void	Init ()
void	CheckGeometry ()
void	ResetNavigator ()
void	SetVerbosity (G4String newValue)
void	SetCheckMode (G4String newValue)
void	SetPushFlag (G4String newValue)
void	RecursiveOverlapTest ()

Private Attributes
G4UIdirectory *	geodir
G4UIdirectory *	navdir
G4UIdirectory *	testdir
G4UIcmdWithABool *	chkCmd
G4UIcmdWithABool *	pchkCmd
G4UIcmdWithABool *	verCmd
G4UIcmdWithoutParameter *	recCmd
G4UIcmdWithoutParameter *	resCmd
G4UIcmdWithADoubleAndUnit *	tolCmd
G4UIcmdWithAnInteger *	verbCmd
G4UIcmdWithAnInteger *	rslCmd
G4UIcmdWithAnInteger *	rcsCmd
G4UIcmdWithAnInteger *	rcdCmd
G4UIcmdWithAnInteger *	errCmd
G4double	tol
G4int	recLevel
G4int	recDepth
G4TransportationManager *	tmanager
G4GeomTestVolume *	tvolume

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 57 of file G4GeometryMessenger.hh.

Constructor & Destructor Documentation

G4GeometryMessenger()

G4GeometryMessenger::G4GeometryMessenger

(

G4TransportationManager *

tman

)

Definition at line 59 of file G4GeometryMessenger.cc.

  : tol(0.0), recLevel(0), recDepth(-1), tmanager(tman), tvolume(0)
{
  geodir = new G4UIdirectory( "/geometry/" );
  geodir->SetGuidance( "Geometry control commands." );

  //
  // Geometry navigator commands
  //
  navdir = new G4UIdirectory( "/geometry/navigator/" );
  navdir->SetGuidance( "Geometry navigator control setup." );

  resCmd = new G4UIcmdWithoutParameter( "/geometry/navigator/reset", this );
  resCmd->SetGuidance( "Reset navigator and navigation history." );
  resCmd->SetGuidance( "NOTE: must be called only after kernel has been" );
  resCmd->SetGuidance( "      initialized once through the run manager!" );
  resCmd->AvailableForStates(G4State_Idle);

  verbCmd = new G4UIcmdWithAnInteger( "/geometry/navigator/verbose", this );
  verbCmd->SetGuidance( "Set run-time verbosity for the navigator." );
  verbCmd->SetGuidance(" 0 : Silent (default)");
  verbCmd->SetGuidance(" 1 : Display volume positioning and step lengths");
  verbCmd->SetGuidance(" 2 : Display step/safety info on point location");
  verbCmd->SetGuidance(" 3 : Display minimal state at -every- step");
  verbCmd->SetGuidance(" 4 : Maximum verbosity (very detailed!)");
  verbCmd->SetGuidance( "NOTE: this command has effect -only- if Geant4 has" );
  verbCmd->SetGuidance( "      been installed with the G4VERBOSE flag set!" );
  verbCmd->SetParameterName("level",true);
  verbCmd->SetDefaultValue(0);
  verbCmd->SetRange("level >=0 && level <=4");

  chkCmd = new G4UIcmdWithABool( "/geometry/navigator/check_mode", this );
  chkCmd->SetGuidance( "Set navigator in -check_mode- state." );
  chkCmd->SetGuidance( "This will cause extra checks to be applied during" );
  chkCmd->SetGuidance( "navigation. More strict and less tolerant conditions" );
  chkCmd->SetGuidance( "are applied. A run-time performance penalty may be" );
  chkCmd->SetGuidance( "observed when the -check_mode- state is activated." );
  chkCmd->SetGuidance( "NOTE: this command has effect -only- if Geant4 has" );
  chkCmd->SetGuidance( "      been installed with the G4VERBOSE flag set!" );
  chkCmd->SetParameterName("checkFlag",true);
  chkCmd->SetDefaultValue(false);
  chkCmd->AvailableForStates(G4State_Idle);

  pchkCmd = new G4UIcmdWithABool( "/geometry/navigator/push_notify", this );
  pchkCmd->SetGuidance( "Set navigator verbosity push notifications." );
  pchkCmd->SetGuidance( "This allows to disable/re-enable verbosity in" );
  pchkCmd->SetGuidance( "navigation, when tracks may get stuck and require" );
  pchkCmd->SetGuidance( "one artificial push along the direction by the" );
  pchkCmd->SetGuidance( "navigator. Notification is active by default." );
  pchkCmd->SetGuidance( "NOTE: this command has effect -only- if Geant4 has" );
  pchkCmd->SetGuidance( "      been installed with the G4VERBOSE flag set!" );
  pchkCmd->SetParameterName("pushFlag",true);
  pchkCmd->SetDefaultValue(true);
  pchkCmd->AvailableForStates(G4State_Idle);

  //
  // Geometry verification test commands
  //
  testdir = new G4UIdirectory( "/geometry/test/" );
  testdir->SetGuidance( "Geometry verification control setup." );
  testdir->SetGuidance( "Helps in detecting possible overlapping regions." );

  tolCmd = new G4UIcmdWithADoubleAndUnit( "/geometry/test/tolerance",this );
  tolCmd->SetGuidance( "Define tolerance (in mm) by which overlaps reports" );
  tolCmd->SetGuidance( "should be reported. By default, all overlaps are" );
  tolCmd->SetGuidance( "reported, i.e. tolerance is set to: 0*mm." );
  tolCmd->SetParameterName( "Tolerance", true, true );
  tolCmd->SetDefaultValue( 0 );
  tolCmd->SetDefaultUnit( "mm" );
  tolCmd->SetUnitCategory( "Length" );

  verCmd = new G4UIcmdWithABool( "/geometry/test/verbosity", this );
  verCmd->SetGuidance( "Specify if running in verbosity mode or not." );
  verCmd->SetGuidance( "By default verbosity is set to ON (TRUE)." );
  verCmd->SetParameterName("verbosity",true);
  verCmd->SetDefaultValue(true);
  verCmd->AvailableForStates(G4State_Idle);

  rslCmd = new G4UIcmdWithAnInteger( "/geometry/test/resolution", this );
  rslCmd->SetGuidance( "Set the number of points on surface to be generated for" );
  rslCmd->SetGuidance( "checking overlaps." );
  rslCmd->SetParameterName("resolution",true);
  rslCmd->SetDefaultValue(10000);

  rcsCmd = new G4UIcmdWithAnInteger( "/geometry/test/recursion_start", this );
  rcsCmd->SetGuidance( "Set the initial level in the geometry tree for recursion." );
  rcsCmd->SetGuidance( "recursive_test will then start from the specified level." );
  rcsCmd->SetParameterName("initial_level",true);
  rcsCmd->SetDefaultValue(0);

  rcdCmd = new G4UIcmdWithAnInteger( "/geometry/test/recursion_depth", this );
  rcdCmd->SetGuidance( "Set the depth in the geometry tree for recursion." );
  rcdCmd->SetGuidance( "recursive_test will then stop after reached the specified depth." );
  rcdCmd->SetGuidance( "By default, recursion will proceed for the whole depth." );
  rcdCmd->SetParameterName("recursion_depth",true);
  rcdCmd->SetDefaultValue(-1);

  errCmd = new G4UIcmdWithAnInteger( "/geometry/test/maximum_errors", this );
  errCmd->SetGuidance( "Set the maximum number of overlap errors to report" );
  errCmd->SetGuidance( "for each single volume being checked." );
  errCmd->SetGuidance( "Once reached the maximum number specified, overlaps" );
  errCmd->SetGuidance( "affecting that volume further than that are simply ignored." );
  errCmd->SetParameterName("maximum_errors",true);
  errCmd->SetDefaultValue(1);

  recCmd = new G4UIcmdWithoutParameter( "/geometry/test/run", this );
  recCmd->SetGuidance( "Start running the recursive overlap check." );
  recCmd->SetGuidance( "Volumes are recursively asked to verify for overlaps" );
  recCmd->SetGuidance( "for points generated on the surface against their" );
  recCmd->SetGuidance( "respective mother volume and sisters at the same" );
  recCmd->SetGuidance( "level, performing for all daughters and daughters of" );
  recCmd->SetGuidance( "daughters, etc." );
  recCmd->SetGuidance( "NOTE: it may take a very long time," );
  recCmd->SetGuidance( "      depending on the geometry complexity !");
  recCmd->AvailableForStates(G4State_Idle);
}

Here is the call graph for this function:

~G4GeometryMessenger()

G4GeometryMessenger::~G4GeometryMessenger

(

)

Definition at line 179 of file G4GeometryMessenger.cc.

{
  delete verCmd; delete recCmd; delete rslCmd;
  delete resCmd; delete rcsCmd; delete rcdCmd; delete errCmd;
  delete tolCmd;
  delete verbCmd; delete pchkCmd; delete chkCmd;
  delete geodir; delete navdir; delete testdir;
  delete tvolume;
}

Member Function Documentation

CheckGeometry()

void G4GeometryMessenger::CheckGeometry ( )

private

Definition at line 274 of file G4GeometryMessenger.cc.

{
  // Verify that the geometry is closed
  //
  G4GeometryManager* geomManager = G4GeometryManager::GetInstance();
  if (!geomManager->IsGeometryClosed()) {
    geomManager->OpenGeometry();
    geomManager->CloseGeometry(true);
  } 
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetCurrentValue()

G4String G4GeometryMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 261 of file G4GeometryMessenger.cc.

{
  G4String cv = "";
  if (command == tolCmd) {
    cv = tolCmd->ConvertToString( tol, "mm" );
  }
  return cv;
}

Here is the call graph for this function:

Init()

void G4GeometryMessenger::Init ( )

private

Definition at line 193 of file G4GeometryMessenger.cc.

{
  // Create checker...
  //
  if (!tvolume)
  {
    // Get the world volume
    //
    G4VPhysicalVolume* world =
      tmanager->GetNavigatorForTracking()->GetWorldVolume();

    // Test the actual detector...
    //
    tvolume = new G4GeomTestVolume(world);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

RecursiveOverlapTest()

void G4GeometryMessenger::RecursiveOverlapTest ( )

private

Definition at line 339 of file G4GeometryMessenger.cc.

{
  // Close geometry if necessary
  //
  CheckGeometry();

  // Make test on single line supplied by user recursively
  //
  tvolume->TestRecursiveOverlap( recLevel, recDepth );
}

Here is the call graph for this function:

Here is the caller graph for this function:

ResetNavigator()

void G4GeometryMessenger::ResetNavigator ( )

private

Definition at line 289 of file G4GeometryMessenger.cc.

{
  // Close geometry and reset optimisation if necessary
  //
  CheckGeometry();

  // Reset navigator's state
  //
  G4ThreeVector pt(0,0,0);
  G4Navigator* navigator = tmanager->GetNavigatorForTracking();
  navigator->LocateGlobalPointAndSetup(pt,0,false);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetCheckMode()

void G4GeometryMessenger::SetCheckMode ( G4String  newValue )

private

Definition at line 317 of file G4GeometryMessenger.cc.

{
  G4bool mode = chkCmd->GetNewBoolValue(input);
  G4Navigator* navigator = tmanager->GetNavigatorForTracking();
  navigator->CheckMode(mode);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetNewValue()

void G4GeometryMessenger::SetNewValue ( G4UIcommand *  command, G4String  newValues  )

virtual

Reimplemented from G4UImessenger.

Definition at line 214 of file G4GeometryMessenger.cc.

{
  if (command == resCmd) {
    ResetNavigator();
  }
  else if (command == verbCmd) {
    SetVerbosity( newValues );
  }
  else if (command == chkCmd) {
    SetCheckMode( newValues );
  }
  else if (command == tolCmd) {
    Init();
    tol = tolCmd->GetNewDoubleValue( newValues )
        * tolCmd->GetNewUnitValue( newValues );
    tvolume->SetTolerance(tol);
  }
  else if (command == verCmd) {
    Init();
    tvolume->SetVerbosity(verCmd->GetNewBoolValue( newValues ));
  }
  else if (command == rslCmd) {
    Init();
    tvolume->SetResolution(rslCmd->GetNewIntValue( newValues ));
  }
  else if (command == rcsCmd) {
    recLevel = rcsCmd->GetNewIntValue( newValues );
  }
  else if (command == rcdCmd) {
    recDepth = rcdCmd->GetNewIntValue( newValues );
  }
  else if (command == errCmd) {
    Init();
    tvolume->SetErrorsThreshold(errCmd->GetNewIntValue( newValues ));
  }
  else if (command == recCmd) {
    Init();
    G4cout << "Running geometry overlaps check..." << G4endl;
    RecursiveOverlapTest();
    G4cout << "Geometry overlaps check completed !" << G4endl;
  }
}

Here is the call graph for this function:

SetPushFlag()

void G4GeometryMessenger::SetPushFlag ( G4String  newValue )

private

Definition at line 328 of file G4GeometryMessenger.cc.

{
  G4bool mode = pchkCmd->GetNewBoolValue(input);
  G4Navigator* navigator = tmanager->GetNavigatorForTracking();
  navigator->SetPushVerbosity(mode);
}

Here is the call graph for this function:

SetVerbosity()

void G4GeometryMessenger::SetVerbosity ( G4String  newValue )

private

Definition at line 306 of file G4GeometryMessenger.cc.

{
  G4int level = verbCmd->GetNewIntValue(input);
  G4Navigator* navigator = tmanager->GetNavigatorForTracking();
  navigator->SetVerboseLevel(level);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

chkCmd

G4UIcmdWithABool* G4GeometryMessenger::chkCmd

private

Definition at line 79 of file G4GeometryMessenger.hh.

errCmd

G4UIcmdWithAnInteger * G4GeometryMessenger::errCmd

private

Definition at line 82 of file G4GeometryMessenger.hh.

geodir

G4UIdirectory* G4GeometryMessenger::geodir

private

Definition at line 78 of file G4GeometryMessenger.hh.

navdir

G4UIdirectory * G4GeometryMessenger::navdir

private

Definition at line 78 of file G4GeometryMessenger.hh.

pchkCmd

G4UIcmdWithABool * G4GeometryMessenger::pchkCmd

private

Definition at line 79 of file G4GeometryMessenger.hh.

rcdCmd

G4UIcmdWithAnInteger * G4GeometryMessenger::rcdCmd

private

Definition at line 82 of file G4GeometryMessenger.hh.

rcsCmd

G4UIcmdWithAnInteger * G4GeometryMessenger::rcsCmd

private

Definition at line 82 of file G4GeometryMessenger.hh.

recCmd

G4UIcmdWithoutParameter* G4GeometryMessenger::recCmd

private

Definition at line 80 of file G4GeometryMessenger.hh.

recDepth

G4int G4GeometryMessenger::recDepth

private

Definition at line 85 of file G4GeometryMessenger.hh.

recLevel

G4int G4GeometryMessenger::recLevel

private

Definition at line 85 of file G4GeometryMessenger.hh.

resCmd

G4UIcmdWithoutParameter * G4GeometryMessenger::resCmd

private

Definition at line 80 of file G4GeometryMessenger.hh.

rslCmd

G4UIcmdWithAnInteger * G4GeometryMessenger::rslCmd

private

Definition at line 82 of file G4GeometryMessenger.hh.

testdir

G4UIdirectory * G4GeometryMessenger::testdir

private

Definition at line 78 of file G4GeometryMessenger.hh.

tmanager

G4TransportationManager* G4GeometryMessenger::tmanager

private

Definition at line 87 of file G4GeometryMessenger.hh.

tol

G4double G4GeometryMessenger::tol

private

Definition at line 84 of file G4GeometryMessenger.hh.

tolCmd

G4UIcmdWithADoubleAndUnit* G4GeometryMessenger::tolCmd

private

Definition at line 81 of file G4GeometryMessenger.hh.

tvolume

G4GeomTestVolume* G4GeometryMessenger::tvolume

private

Definition at line 88 of file G4GeometryMessenger.hh.

verbCmd

G4UIcmdWithAnInteger* G4GeometryMessenger::verbCmd

private

Definition at line 82 of file G4GeometryMessenger.hh.

verCmd

G4UIcmdWithABool * G4GeometryMessenger::verCmd

private

Definition at line 79 of file G4GeometryMessenger.hh.

---

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

• G4GeometryMessenger.hh
• G4GeometryMessenger.cc