#include <G4ProcessManagerMessenger.hh>

Inheritance diagram for G4ProcessManagerMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

	G4ProcessManagerMessenger (const G4ProcessManagerMessenger &)=delete

	G4ProcessManagerMessenger (G4ParticleTable *pTable=nullptr)

virtual G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator!= (const G4UImessenger &messenger) const

G4ProcessManagerMessenger &	operator= (const G4ProcessManagerMessenger &)=delete

G4bool	operator== (const G4UImessenger &messenger) const

virtual void	SetNewValue (G4UIcommand *command, G4String newValues)

virtual	~G4ProcessManagerMessenger ()

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 Member Functions
const G4ParticleDefinition *	SetCurrentParticle ()

Private Attributes
G4UIcmdWithAnInteger *	activateCmd = nullptr

const G4ParticleDefinition *	currentParticle = nullptr

G4VProcess *	currentProcess = nullptr

G4UIcmdWithAnInteger *	dumpCmd = nullptr

G4UIcmdWithAnInteger *	inactivateCmd = nullptr

G4ProcessManager *	theManager = nullptr

G4ParticleTable *	theParticleTable = nullptr

G4ProcessVector *	theProcessList = nullptr

G4UIdirectory *	thisDirectory = nullptr

G4UIcommand *	verboseCmd = nullptr

Detailed Description

Definition at line 59 of file G4ProcessManagerMessenger.hh.

Constructor & Destructor Documentation

◆ G4ProcessManagerMessenger() [1/2]

G4ProcessManagerMessenger::G4ProcessManagerMessenger ( G4ParticleTable * pTable = nullptr )

Definition at line 50 of file G4ProcessManagerMessenger.cc.

  : theParticleTable(pTable)
{
  if ( theParticleTable == nullptr)
    theParticleTable = G4ParticleTable::GetParticleTable();
 
  // Command   /particle/process
  thisDirectory = new G4UIdirectory("/particle/process/");
  thisDirectory->SetGuidance("Process Manager control commands.");
 
  // Command   /particle/process/dump
  dumpCmd = new G4UIcmdWithAnInteger("/particle/process/dump",this);
  dumpCmd->SetGuidance("dump process manager or process information");
  dumpCmd->SetGuidance("  dump [process index]");
  dumpCmd->SetGuidance("   process index: -1 for process manager");
  dumpCmd->SetParameterName("index", true);
  dumpCmd->SetDefaultValue(-1);
 
  // Command   /particle/process/verbose
  verboseCmd = new G4UIcommand("/particle/process/verbose",this);
  verboseCmd->SetGuidance("Set Verbose Level for Process or Process Manager");
  verboseCmd->SetGuidance("  Verbose [Verbose] [process index]");
  verboseCmd->SetGuidance("   process index: -1 for process manager");
  G4UIparameter* param = new G4UIparameter("Verbose",'i',true);
  param->SetDefaultValue(1);
  verboseCmd->SetParameter(param);
  param = new G4UIparameter("index",'i',true);
  param->SetDefaultValue(-1);
  verboseCmd->SetParameter(param);
  verboseCmd->AvailableForStates(G4State_PreInit,G4State_Init,G4State_Idle,G4State_GeomClosed,G4State_EventProc);
 
  // Command   /particle/process/activate
  activateCmd = new G4UIcmdWithAnInteger("/particle/process/activate",this);
  activateCmd->SetGuidance("Activate process  ");
  activateCmd->SetGuidance(" Activate [process index]");
  activateCmd->SetParameterName("index", false);
  activateCmd->SetDefaultValue(0);
  activateCmd->SetRange("index >=0");
  activateCmd->AvailableForStates(G4State_Idle);
 
  // Command   /particle/process/inactivate
  inactivateCmd = new G4UIcmdWithAnInteger("/particle/process/inactivate",this);
  inactivateCmd->SetGuidance("Inactivate process  ");
  inactivateCmd->SetGuidance(" inactivate [process index]");
  inactivateCmd->SetParameterName("index", false);
  inactivateCmd->SetDefaultValue(0);
  inactivateCmd->SetRange("index >=0");
  inactivateCmd->AvailableForStates(G4State_Idle);
}

References activateCmd, G4UIcommand::AvailableForStates(), dumpCmd, G4State_EventProc, G4State_GeomClosed, G4State_Idle, G4State_Init, G4State_PreInit, G4ParticleTable::GetParticleTable(), inactivateCmd, G4UIparameter::SetDefaultValue(), G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcommand::SetGuidance(), G4UIcommand::SetParameter(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcommand::SetRange(), theParticleTable, thisDirectory, and verboseCmd.

◆ ~G4ProcessManagerMessenger()

G4ProcessManagerMessenger::~G4ProcessManagerMessenger ( )

virtual

Definition at line 101 of file G4ProcessManagerMessenger.cc.

{
  delete activateCmd; 
  delete inactivateCmd; 
  delete verboseCmd;
  delete dumpCmd;
  delete thisDirectory;
}

References activateCmd, dumpCmd, inactivateCmd, thisDirectory, and verboseCmd.

◆ G4ProcessManagerMessenger() [2/2]

G4ProcessManagerMessenger::G4ProcessManagerMessenger ( const G4ProcessManagerMessenger & )

delete

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 G4ProcessManagerMessenger::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 219 of file G4ProcessManagerMessenger.cc.

{
  if(SetCurrentParticle() == nullptr) return "";
 
  if( command==verboseCmd )
  {
    // Command   /particle/process/Verbose
    return verboseCmd->ConvertToString(theManager->GetVerboseLevel());
  }
  else
  {
    return "";
  }   
}

References G4UIcommand::ConvertToString(), G4ProcessManager::GetVerboseLevel(), SetCurrentParticle(), theManager, 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=()

G4ProcessManagerMessenger & G4ProcessManagerMessenger::operator= ( const G4ProcessManagerMessenger & )

delete

◆ operator==()

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

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetCurrentParticle()

const G4ParticleDefinition * G4ProcessManagerMessenger::SetCurrentParticle ( )

private

Definition at line 111 of file G4ProcessManagerMessenger.cc.

{
  // access to selected particle in the G4ParticleTable
  currentParticle = theParticleTable->GetSelectedParticle();
  if (currentParticle == nullptr)
  {
    theManager = nullptr;
    G4cout << "G4ProcessManagerMessenger::SetCurrentParticle() - not selected";
  }
  else
  {
    theManager = currentParticle->GetProcessManager();
    theProcessList = theManager->GetProcessList();
  }
  return currentParticle;
}

References currentParticle, G4cout, G4ProcessManager::GetProcessList(), G4ParticleDefinition::GetProcessManager(), G4ParticleTable::GetSelectedParticle(), theManager, theParticleTable, and theProcessList.

Referenced by GetCurrentValue(), and SetNewValue().

◆ SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 129 of file G4ProcessManagerMessenger.cc.

{
  G4ExceptionDescription ed;
  if (SetCurrentParticle() == nullptr)
  {
      ed << "Particle is not selected yet !! Command ignored.";
      command->CommandFailed(ed);
      return;
  }
  if( command == dumpCmd )
  {
    // Command   /particle/process/dump
    G4int index = dumpCmd->GetNewIntValue(newValue);
    if (index <0)
    {
       theManager->DumpInfo();
    }
    else if ( index < theManager->GetProcessListLength())
    {
      currentProcess =  (*theProcessList)(index);
      if (currentProcess == nullptr)
      {
    ed << " no process at index of " << index
       << " in the Process Vector";
        command->CommandFailed(ed);
      }
      else
      {
    currentProcess->DumpInfo();
      }
    }
    else
    {
      ed << " illegal index !!! ";
      command->CommandFailed(ed);
      currentProcess = nullptr;
    } 
 
  }
  else if( command==activateCmd )
  {
    // Command   /particle/process/activate
    theManager->SetProcessActivation(activateCmd->GetNewIntValue(newValue), true);
    G4UImanager::GetUIpointer()->ApplyCommand("/run/physicsModified");
    
  }
  else if( command==inactivateCmd )
  {
    // Command   /particle/process/inactivate
    theManager->SetProcessActivation(inactivateCmd->GetNewIntValue(newValue), false);
    G4UImanager::GetUIpointer()->ApplyCommand("/run/physicsModified");
    
  }
  else if( command==verboseCmd )
  {
    // Command   /particle/process/Verbose
    //  inputstream for newValues 
    const char* temp = (const char*)(newValue);
    std::istringstream is((char*)temp);
    G4int Verbose, index;
    is  >>Verbose >>index;
    if (index <0)
    {
      theManager->SetVerboseLevel(Verbose);
      
    }
    else if ( index < theManager->GetProcessListLength())
    {
      currentProcess =  (*theProcessList)(index);
      if (currentProcess == nullptr)
      {
    ed << " no process at index of " << index
       << " in the Process Vector";
        command->CommandFailed(ed);
      }
      else
      {
    currentProcess->SetVerboseLevel(Verbose);
      }
    }
    else
    {
      ed << " illegal index !!! ";
      command->CommandFailed(ed);
      currentProcess = nullptr;
    } 
  }
}

References activateCmd, G4UImanager::ApplyCommand(), G4UIcommand::CommandFailed(), currentProcess, dumpCmd, G4ProcessManager::DumpInfo(), G4VProcess::DumpInfo(), G4UIcmdWithAnInteger::GetNewIntValue(), G4UImanager::GetUIpointer(), inactivateCmd, SetCurrentParticle(), G4ProcessManager::SetProcessActivation(), G4ProcessManager::SetVerboseLevel(), G4VProcess::SetVerboseLevel(), theManager, 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

◆ activateCmd

G4UIcmdWithAnInteger* G4ProcessManagerMessenger::activateCmd = nullptr

private

Definition at line 93 of file G4ProcessManagerMessenger.hh.

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

◆ 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().

◆ currentParticle

const G4ParticleDefinition* G4ProcessManagerMessenger::currentParticle = nullptr

private

Definition at line 85 of file G4ProcessManagerMessenger.hh.

Referenced by SetCurrentParticle().

◆ currentProcess

G4VProcess* G4ProcessManagerMessenger::currentProcess = nullptr

private

Definition at line 86 of file G4ProcessManagerMessenger.hh.

Referenced by SetNewValue().

◆ dumpCmd

G4UIcmdWithAnInteger* G4ProcessManagerMessenger::dumpCmd = nullptr

private

Definition at line 91 of file G4ProcessManagerMessenger.hh.

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

◆ inactivateCmd

G4UIcmdWithAnInteger* G4ProcessManagerMessenger::inactivateCmd = nullptr

private

Definition at line 94 of file G4ProcessManagerMessenger.hh.

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

◆ theManager

G4ProcessManager* G4ProcessManagerMessenger::theManager = nullptr

private

Definition at line 87 of file G4ProcessManagerMessenger.hh.

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

◆ theParticleTable

G4ParticleTable* G4ProcessManagerMessenger::theParticleTable = nullptr

private

Definition at line 84 of file G4ProcessManagerMessenger.hh.

Referenced by G4ProcessManagerMessenger(), and SetCurrentParticle().

◆ theProcessList

G4ProcessVector* G4ProcessManagerMessenger::theProcessList = nullptr

private

Definition at line 88 of file G4ProcessManagerMessenger.hh.

Referenced by SetCurrentParticle().

◆ thisDirectory

G4UIdirectory* G4ProcessManagerMessenger::thisDirectory = nullptr

private

Definition at line 90 of file G4ProcessManagerMessenger.hh.

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

◆ verboseCmd

G4UIcommand* G4ProcessManagerMessenger::verboseCmd = nullptr

private

Definition at line 92 of file G4ProcessManagerMessenger.hh.

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

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

source/processes/management/include/G4ProcessManagerMessenger.hh
source/processes/management/src/G4ProcessManagerMessenger.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4ProcessManagerMessenger() [1/2]

◆ ~G4ProcessManagerMessenger()

◆ G4ProcessManagerMessenger() [2/2]

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ SetCurrentParticle()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Field Documentation

◆ activateCmd

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster

◆ currentParticle

◆ currentProcess

◆ dumpCmd

◆ inactivateCmd

◆ theManager

◆ theParticleTable

◆ theProcessList

◆ thisDirectory

◆ verboseCmd