G4TrackingMessenger Class Reference

#include <G4TrackingMessenger.hh>

Inheritance diagram for G4TrackingMessenger:

Public Member Functions
	G4TrackingMessenger (G4TrackingManager *trMan)
	~G4TrackingMessenger () override
void	SetNewValue (G4UIcommand *command, G4String newValues) override
G4String	GetCurrentValue (G4UIcommand *command) override
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()=default
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	CommandsShouldBeInMaster () const

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 52 of file G4TrackingMessenger.hh.

Constructor & Destructor Documentation

G4TrackingMessenger()

G4TrackingMessenger::G4TrackingMessenger

(

G4TrackingManager *

trMan

)

Definition at line 51 of file G4TrackingMessenger.cc.

  : trackingManager(trMan)
{
  steppingManager = trackingManager->GetSteppingManager();
 
  TrackingDirectory = new G4UIdirectory("/tracking/");
  TrackingDirectory->SetGuidance("TrackingManager and SteppingManager control commands.");
 
  AbortCmd = new G4UIcmdWithoutParameter("/tracking/abort", this);
  AbortCmd->SetGuidance("Abort current G4Track processing.");
 
  ResumeCmd = new G4UIcmdWithoutParameter("/tracking/resume", this);
  ResumeCmd->SetGuidance("Resume current G4Track processing.");
 
  StoreTrajectoryCmd = new G4UIcmdWithAnInteger("/tracking/storeTrajectory", this);
  StoreTrajectoryCmd->SetGuidance("Store trajectories or not.");
  StoreTrajectoryCmd->SetGuidance(" 0 : Don't Store trajectories.");
  StoreTrajectoryCmd->SetGuidance(" !=0 : Store trajectories.");
  StoreTrajectoryCmd->SetGuidance(" 1 : Choose G4Trajectory as default.");
  StoreTrajectoryCmd->SetGuidance(" 2 : Choose G4SmoothTrajectory as default.");
  StoreTrajectoryCmd->SetGuidance(" 3 : Choose G4RichTrajectory as default.");
  StoreTrajectoryCmd->SetGuidance(" 4 : Choose G4RichTrajectory with auxiliary points as default.");
  StoreTrajectoryCmd->SetParameterName("Store", true);
  StoreTrajectoryCmd->SetDefaultValue(0);
  StoreTrajectoryCmd->SetRange("Store >=0 && Store <= 4");
 
  VerboseCmd = new G4UIcmdWithAnInteger("/tracking/verbose", this);
#ifdef G4VERBOSE
  VerboseCmd->SetGuidance("Set Verbose level of tracking category.");
  VerboseCmd->SetGuidance(" -1 : Silent.");
  VerboseCmd->SetGuidance(" 0 : Silent.");
  VerboseCmd->SetGuidance(" 1 : Minimum information of each Step.");
  VerboseCmd->SetGuidance(" 2 : Addition to Level=1, info of secondary particles.");
  VerboseCmd->SetGuidance(" 3 : Addition to Level=1, pre/postStepoint information");
  VerboseCmd->SetGuidance("     after all AlongStep/PostStep process executions.");
  VerboseCmd->SetGuidance(" 4 : Addition to Level=3, pre/postStepoint information");
  VerboseCmd->SetGuidance("     at each AlongStepPostStep process execution.");
  VerboseCmd->SetGuidance(" 5 : Addition to Level=4, proposed Step length information");
  VerboseCmd->SetGuidance("     from each AlongStepPostStep process.");
  VerboseCmd->SetParameterName("verbose_level", true);
  VerboseCmd->SetDefaultValue(0);
  VerboseCmd->SetRange("verbose_level >=-1  ");
#else
  VerboseCmd->SetGuidance("You need to recompile the tracking category defining G4VERBOSE ");
#endif
}

~G4TrackingMessenger()

G4TrackingMessenger::~G4TrackingMessenger ( )

override

Definition at line 100 of file G4TrackingMessenger.cc.

{
  delete TrackingDirectory;
  delete AbortCmd;
  delete ResumeCmd;
  delete StoreTrajectoryCmd;
  delete VerboseCmd;
  delete auxiliaryPointsFilter;
}

Member Function Documentation

GetCurrentValue()

G4String G4TrackingMessenger::GetCurrentValue ( G4UIcommand * command )

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 149 of file G4TrackingMessenger.cc.

{
  if (command == VerboseCmd) {
    return VerboseCmd->ConvertToString(trackingManager->GetVerboseLevel());
  }
  if (command == StoreTrajectoryCmd) {
    return StoreTrajectoryCmd->ConvertToString(trackingManager->GetStoreTrajectory());
  }
  return G4String(1, '\0');
}

SetNewValue()

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

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 112 of file G4TrackingMessenger.cc.

{
  if (command == VerboseCmd) {
    trackingManager->SetVerboseLevel(VerboseCmd->ConvertToInt(newValues));
  }
 
  if (command == AbortCmd) {
    steppingManager->GetTrack()->SetTrackStatus(fStopAndKill);
    G4UImanager::GetUIpointer()->ApplyCommand("/control/exit");
  }
 
  if (command == ResumeCmd) {
    G4UImanager::GetUIpointer()->ApplyCommand("/control/exit");
  }
 
  if (command == StoreTrajectoryCmd) {
    G4int trajType = StoreTrajectoryCmd->ConvertToInt(newValues);
    if (trajType == 2 || trajType == 4) {
 
      if (nullptr == auxiliaryPointsFilter) {
    auxiliaryPointsFilter = new G4IdentityTrajectoryFilter;
      }
      G4TransportationManager::GetTransportationManager()
        ->GetPropagatorInField()
        ->SetTrajectoryFilter(auxiliaryPointsFilter);
    }
    else {
      G4TransportationManager::GetTransportationManager()
        ->GetPropagatorInField()
        ->SetTrajectoryFilter(nullptr);
    }
    trackingManager->SetStoreTrajectory(trajType);
  }
}

---

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

• G4TrackingMessenger.hh
• G4TrackingMessenger.cc