#include <G4TrackingMessenger.hh>

Inheritance diagram for G4TrackingMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

	G4TrackingMessenger (G4TrackingManager *trMan)

G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator!= (const G4UImessenger &messenger) const

G4bool	operator== (const G4UImessenger &messenger) const

void	SetNewValue (G4UIcommand *command, G4String newValues)

	~G4TrackingMessenger ()

Protected Member Functions
void	AddUIcommand (G4UIcommand *newCommand)

G4String	BtoS (G4bool b)

template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)

void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)

G4String	DtoS (G4double a)

G4String	ItoS (G4int i)

G4bool	StoB (G4String s)

G4double	StoD (G4String s)

G4int	StoI (G4String s)

G4long	StoL (G4String s)

Protected Attributes
G4UIdirectory *	baseDir = nullptr

G4String	baseDirName = ""

G4bool	commandsShouldBeInMaster = false

Private Attributes
G4UIcmdWithoutParameter *	AbortCmd = nullptr

G4UIcmdWithoutParameter *	ResumeCmd = nullptr

G4SteppingManager *	steppingManager = nullptr

G4UIcmdWithAnInteger *	StoreTrajectoryCmd = nullptr

G4UIdirectory *	TrackingDirectory = nullptr

G4TrackingManager *	trackingManager = nullptr

G4UIcmdWithAnInteger *	VerboseCmd = nullptr

Detailed Description

Definition at line 51 of file G4TrackingMessenger.hh.

Constructor & Destructor Documentation

◆ G4TrackingMessenger()

G4TrackingMessenger::G4TrackingMessenger ( G4TrackingManager * trMan )

Definition at line 50 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
}

References AbortCmd, G4TrackingManager::GetSteppingManager(), ResumeCmd, G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcommand::SetGuidance(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcommand::SetRange(), steppingManager, StoreTrajectoryCmd, TrackingDirectory, trackingManager, and VerboseCmd.

◆ ~G4TrackingMessenger()

G4TrackingMessenger::~G4TrackingMessenger ( )

Definition at line 99 of file G4TrackingMessenger.cc.

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

References AbortCmd, ResumeCmd, StoreTrajectoryCmd, TrackingDirectory, and VerboseCmd.

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand * newCommand )

protectedinherited

Definition at line 149 of file G4UImessenger.cc.

{
  G4cerr << "Warning : Old style definition of G4UIcommand <"
         << newCommand->GetCommandPath() << ">." << G4endl;
}

References G4cerr, G4endl, and G4UIcommand::GetCommandPath().

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool b )

protectedinherited

Definition at line 98 of file G4UImessenger.cc.

{
  G4String vl = "0";
  if(b)
    vl = "true";
  return vl;
}

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inlineinherited

Definition at line 77 of file G4UImessenger.hh.

    {
      return commandsShouldBeInMaster;
    }

References G4UImessenger::commandsShouldBeInMaster.

Referenced by G4UIcommand::G4UIcommandCommonConstructorCode().

◆ CreateCommand()

template<typename T >

T * G4UImessenger::CreateCommand	(	const G4String &	cname,
		const G4String &	dsc
	)

protectedinherited

Definition at line 110 of file G4UImessenger.hh.

{
  G4String path;
  if(cname[0] != '/')
  {
    path = baseDirName + cname;
    if(path[0] != '/')
      path = "/" + path;
  }
 
  T* command = new T(path.c_str(), this);
  command->SetGuidance(dsc.c_str());
 
  return command;
}

References G4UImessenger::baseDirName.

◆ CreateDirectory()

void G4UImessenger::CreateDirectory	(	const G4String &	path,
		const G4String &	dsc,
		G4bool	commandsToBeBroadcasted = `true`
	)

protectedinherited

Definition at line 156 of file G4UImessenger.cc.

{
  G4UImanager* ui = G4UImanager::GetUIpointer();
 
  G4String fullpath = path;
  if(fullpath.back() != '/')
    fullpath.append("/");
 
  G4UIcommandTree* tree = ui->GetTree()->FindCommandTree(fullpath.c_str());
  if(tree != nullptr)
  {
    baseDirName = tree->GetPathName();
  }
  else
  {
    baseDir     = new G4UIdirectory(fullpath.c_str(), commandsToBeBroadcasted);
    baseDirName = fullpath;
    baseDir->SetGuidance(dsc.c_str());
  }
}

References G4UImessenger::baseDir, G4UImessenger::baseDirName, G4UIcommandTree::FindCommandTree(), G4UIcommandTree::GetPathName(), G4UImanager::GetTree(), G4UImanager::GetUIpointer(), and G4UIcommand::SetGuidance().

Referenced by G4MoleculeShootMessenger::G4MoleculeShootMessenger(), and G4UImessenger::G4UImessenger().

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double a )

protectedinherited

Definition at line 90 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << a;
  return G4String(os.str());
}

Referenced by G4ScoreQuantityMessenger::FilterCommands(), and G4UIcontrolMessenger::SetNewValue().

◆ GetCurrentValue()

G4String G4TrackingMessenger::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 153 of file G4TrackingMessenger.cc.

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

References G4UIcommand::ConvertToString(), G4TrackingManager::GetStoreTrajectory(), G4TrackingManager::GetVerboseLevel(), StoreTrajectoryCmd, trackingManager, and VerboseCmd.

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int i )

protectedinherited

Definition at line 82 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << i;
  return G4String(os.str());
}

Referenced by G4GenericMessenger::DeclareMethod(), and G4ParticleGunMessenger::GetCurrentValue().

◆ operator!=()

G4bool G4UImessenger::operator!= ( const G4UImessenger & messenger ) const

inherited

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

◆ operator==()

G4bool G4UImessenger::operator== ( const G4UImessenger & messenger ) const

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 110 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");
  }
 
  static G4ThreadLocal
         G4IdentityTrajectoryFilter* auxiliaryPointsFilter = nullptr;
  if(auxiliaryPointsFilter == nullptr)
  {
    auxiliaryPointsFilter = new G4IdentityTrajectoryFilter;
  }
  if( command == StoreTrajectoryCmd )
  {
    G4int trajType = StoreTrajectoryCmd->ConvertToInt(newValues);
    if(trajType==2||trajType==4)
    {
      G4TransportationManager::GetTransportationManager()
        ->GetPropagatorInField()->SetTrajectoryFilter(auxiliaryPointsFilter);
    }
    else
    {
      G4TransportationManager::GetTransportationManager()
        ->GetPropagatorInField()->SetTrajectoryFilter(0);
    }
    trackingManager->SetStoreTrajectory(trajType);
  }
}

References AbortCmd, G4UImanager::ApplyCommand(), G4UIcommand::ConvertToInt(), fStopAndKill, G4ThreadLocal, G4TransportationManager::GetPropagatorInField(), G4SteppingManager::GetTrack(), G4TransportationManager::GetTransportationManager(), G4UImanager::GetUIpointer(), ResumeCmd, G4TrackingManager::SetStoreTrajectory(), G4Track::SetTrackStatus(), G4PropagatorInField::SetTrajectoryFilter(), G4TrackingManager::SetVerboseLevel(), steppingManager, StoreTrajectoryCmd, trackingManager, and VerboseCmd.

◆ StoB()

G4bool G4UImessenger::StoB ( G4String s )

protectedinherited

Definition at line 137 of file G4UImessenger.cc.

{
  G4String v = G4StrUtil::to_upper_copy(str);
  G4bool vl = false;
  if(v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE")
  {
    vl = true;
  }
  return vl;
}

References G4StrUtil::to_upper_copy().

Referenced by G4LocalThreadCoutMessenger::SetNewValue(), G4CascadeParamMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoD()

G4double G4UImessenger::StoD ( G4String s )

protectedinherited

Definition at line 127 of file G4UImessenger.cc.

{
  G4double vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoreQuantityMessenger::FParticleWithEnergyCommand(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddText2D::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4PolarizationMessenger::SetNewValue().

◆ StoI()

G4int G4UImessenger::StoI ( G4String s )

protectedinherited

Definition at line 107 of file G4UImessenger.cc.

{
  G4int vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoringMessenger::Fill1D(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4ParticleGunMessenger::IonLevelCommand(), G4GeneralParticleSourceMessenger::IonLvlCommand(), G4ScoringMessenger::MeshBinCommand(), G4LocalThreadCoutMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoL()

G4long G4UImessenger::StoL ( G4String s )

protectedinherited

Definition at line 117 of file G4UImessenger.cc.

{
  G4long vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4RunMessenger::SetNewValue().

Field Documentation

◆ AbortCmd

G4UIcmdWithoutParameter* G4TrackingMessenger::AbortCmd = nullptr

private

Definition at line 69 of file G4TrackingMessenger.hh.

Referenced by G4TrackingMessenger(), SetNewValue(), and ~G4TrackingMessenger().

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protectedinherited

Definition at line 102 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateDirectory(), and G4UImessenger::~G4UImessenger().

◆ baseDirName

G4String G4UImessenger::baseDirName = ""

protectedinherited

Definition at line 103 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateCommand(), and G4UImessenger::CreateDirectory().

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protectedinherited

Definition at line 104 of file G4UImessenger.hh.

Referenced by G4UImessenger::CommandsShouldBeInMaster(), and G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger().

◆ ResumeCmd

G4UIcmdWithoutParameter* G4TrackingMessenger::ResumeCmd = nullptr

private

Definition at line 70 of file G4TrackingMessenger.hh.

Referenced by G4TrackingMessenger(), SetNewValue(), and ~G4TrackingMessenger().

◆ steppingManager

G4SteppingManager* G4TrackingMessenger::steppingManager = nullptr

private

Definition at line 64 of file G4TrackingMessenger.hh.

Referenced by G4TrackingMessenger(), and SetNewValue().

◆ StoreTrajectoryCmd

G4UIcmdWithAnInteger* G4TrackingMessenger::StoreTrajectoryCmd = nullptr

private

Definition at line 71 of file G4TrackingMessenger.hh.

Referenced by G4TrackingMessenger(), GetCurrentValue(), SetNewValue(), and ~G4TrackingMessenger().

◆ TrackingDirectory

G4UIdirectory* G4TrackingMessenger::TrackingDirectory = nullptr

private

Definition at line 68 of file G4TrackingMessenger.hh.

Referenced by G4TrackingMessenger(), and ~G4TrackingMessenger().

◆ trackingManager

G4TrackingManager* G4TrackingMessenger::trackingManager = nullptr

private

Definition at line 63 of file G4TrackingMessenger.hh.

Referenced by G4TrackingMessenger(), GetCurrentValue(), and SetNewValue().

◆ VerboseCmd

G4UIcmdWithAnInteger* G4TrackingMessenger::VerboseCmd = nullptr

private

Definition at line 72 of file G4TrackingMessenger.hh.

Referenced by G4TrackingMessenger(), GetCurrentValue(), SetNewValue(), and ~G4TrackingMessenger().

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

source/tracking/include/G4TrackingMessenger.hh
source/tracking/src/G4TrackingMessenger.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4TrackingMessenger()

◆ ~G4TrackingMessenger()

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ operator!=()

◆ operator==()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Field Documentation

◆ AbortCmd

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster

◆ ResumeCmd

◆ steppingManager

◆ StoreTrajectoryCmd

◆ TrackingDirectory

◆ trackingManager

◆ VerboseCmd