G4ProcessTableMessenger Class Reference

#include <G4ProcessTableMessenger.hh>

Inheritance diagram for G4ProcessTableMessenger:

Public Member Functions
	G4ProcessTableMessenger (G4ProcessTable *pTable)
virtual	~G4ProcessTableMessenger ()
	G4ProcessTableMessenger (const G4ProcessTableMessenger &)=delete
G4ProcessTableMessenger &	operator= (const G4ProcessTableMessenger &)=delete
virtual void	SetNewValue (G4UIcommand *command, G4String newValues)
virtual G4String	GetCurrentValue (G4UIcommand *command)
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 (const 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 55 of file G4ProcessTableMessenger.hh.

Constructor & Destructor Documentation

G4ProcessTableMessenger() [1/2]

G4ProcessTableMessenger::G4ProcessTableMessenger

(

G4ProcessTable *

pTable

)

Definition at line 52 of file G4ProcessTableMessenger.cc.

  : theProcessTable(pTable)
{ 
  // Command   /particle/process
  thisDirectory = new G4UIdirectory("/process/");
  thisDirectory->SetGuidance("Process Table control commands.");
 
  // Command   /particle/process/list
  listCmd = new G4UIcmdWithAString("/process/list",this);
  listCmd->SetGuidance("List up process names");
  listCmd->SetGuidance("  list [type] ");
  listCmd->SetGuidance("    type: process type [all:for all processes]");
  listCmd->SetParameterName("type", true);
  listCmd->SetDefaultValue("all");
  SetNumberOfProcessType();
 
  G4String candidates("all");
  for (G4int idx = 0; idx < NumberOfProcessType ; ++idx )
  {
    candidates += " " + G4VProcess::GetProcessTypeName(G4ProcessType(idx));
  }
  listCmd->SetCandidates((const char*)(candidates));
 
  // Command   /particle/process/verbose
  verboseCmd = new G4UIcmdWithAnInteger("/process/verbose",this);
  verboseCmd->SetGuidance("Set Verbose Level for Process Table");
  verboseCmd->SetGuidance("  verbose [level]");
  verboseCmd->SetGuidance("   level: verbose level");
  verboseCmd->SetParameterName("verbose", true);
  verboseCmd->SetDefaultValue(1);
  verboseCmd->SetRange("verbose >=0");
  verboseCmd->AvailableForStates(G4State_PreInit,G4State_Init,G4State_Idle,G4State_GeomClosed,G4State_EventProc);
 
  // Command   /particle/process/setVerbose
  procVerboseCmd = new G4UIcommand("/process/setVerbose",this);
  procVerboseCmd->SetGuidance("Set verbose level for processes");
  procVerboseCmd->SetGuidance("  setVerbose level [type or name] ");
  procVerboseCmd->SetGuidance("    level: verbose level ");
  procVerboseCmd->SetGuidance("    name : process name ");
  procVerboseCmd->SetGuidance("    type : process type ");
  procVerboseCmd->SetGuidance("       [all] for all processes ");
  G4UIparameter* param = new G4UIparameter("verbose",'i',false);
  procVerboseCmd->SetParameter(param);
  param = new G4UIparameter("type",'s',true);
  param->SetDefaultValue("all");
  procVerboseCmd->SetParameter(param);
  procVerboseCmd->AvailableForStates(G4State_Idle,G4State_GeomClosed,G4State_EventProc);
 
  // Command   /particle/process/dump
  dumpCmd = new G4UIcommand("/process/dump",this);
  dumpCmd->SetGuidance("Dump process information");
  dumpCmd->SetGuidance(" dump name [particle]");
  dumpCmd->SetGuidance("   name:     process name or type name");
  dumpCmd->SetGuidance("   particle: particle name [all: for all particles]");
  param = new G4UIparameter("procName",'s',false);
  dumpCmd->SetParameter(param);
  param = new G4UIparameter("particle",'s',true);
  param->SetDefaultValue("all");
  dumpCmd->SetParameter(param);
  dumpCmd->AvailableForStates(G4State_Init,G4State_Idle,G4State_GeomClosed,G4State_EventProc);
 
  // Command   /process/activate
  activateCmd = new G4UIcommand("/process/activate",this);
  activateCmd->SetGuidance("Activate processes  ");
  activateCmd->SetGuidance(" Activate  name [particle]");
  activateCmd->SetGuidance("   name:     process name or type name");
  activateCmd->SetGuidance("   particle: particle name [all: for all particles]");
  param = new G4UIparameter("procName",'s',false);
  activateCmd->SetParameter(param);
  param = new G4UIparameter("particle",'s',true);
  param->SetDefaultValue("all");
  activateCmd->SetParameter(param);
  activateCmd->AvailableForStates(G4State_Idle);
  
  // Command   /process/inactivate
  inactivateCmd = new G4UIcommand("/process/inactivate",this);
  inactivateCmd->SetGuidance("Inactivate process  ");
  inactivateCmd->SetGuidance("Inactivate processes  ");
  inactivateCmd->SetGuidance(" Inactivate  name [particle]");
  inactivateCmd->SetGuidance("   name:     process name or type name");
  inactivateCmd->SetGuidance("   particle: particle name [all: for all particles]");
  param = new G4UIparameter("procName",'s',false);
  inactivateCmd->SetParameter(param);
  param = new G4UIparameter("particle",'s',true);
  param->SetDefaultValue("all");
  inactivateCmd->SetParameter(param);
  inactivateCmd->AvailableForStates(G4State_Idle);
}

Referenced by G4ProcessTableMessenger(), G4ProcessTableMessenger(), and operator=().

~G4ProcessTableMessenger()

G4ProcessTableMessenger::~G4ProcessTableMessenger ( )

virtual

Definition at line 142 of file G4ProcessTableMessenger.cc.

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

G4ProcessTableMessenger() [2/2]

G4ProcessTableMessenger::G4ProcessTableMessenger ( const G4ProcessTableMessenger & )

delete

Member Function Documentation

GetCurrentValue()

G4String G4ProcessTableMessenger::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 364 of file G4ProcessTableMessenger.cc.

{
  if( command==verboseCmd )
  {
    // Command   /process/verbose
    return verboseCmd->ConvertToString(theProcessTable->GetVerboseLevel());
  }
  else if ( command==listCmd )
  {
    // Command   /process/list
    return currentProcessTypeName;
  }
  else
  {
    // Command   /process/dump, activate, inactivate
    return   (currentProcessName + " " + currentParticleName);
  }
 
  return "";
}

operator=()

G4ProcessTableMessenger & G4ProcessTableMessenger::operator= ( const G4ProcessTableMessenger & )

delete

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 155 of file G4ProcessTableMessenger.cc.

{
  G4ProcessTable::G4ProcNameVector* procNameVector 
                         = theProcessTable->GetNameList(); 
  G4int type = -1;
  G4ExceptionDescription ed;
 
  if( command == listCmd )
  {
    // Command  /process/list
    type = -1;
    if (newValue == "all")
    {
      currentProcessTypeName = std::move(newValue);
    }
    else
    {
      type  = GetProcessType(newValue);
      if (type <0)
      {
        G4cout << " illegal type !!! " << G4endl;
      }
      else
      {
        currentProcessTypeName = std::move(newValue);
      }
    }    
    G4int counter = 0;
    for (auto itr=procNameVector->cbegin(); itr!=procNameVector->cend(); ++itr)
    {
      G4ProcessVector* tmpVector = theProcessTable->FindProcesses(*itr);
      if ( (type <0) || ( ((*tmpVector)(0)->GetProcessType()) == type) )
      {
        if ( counter%4 != 0) G4cout << ",";
        G4cout << std::setw(19) << *itr;
        if ((counter++)%4 == 3)
        {
          G4cout << G4endl;
        }
      }
      delete tmpVector;
    }
    G4cout << G4endl;
  }
  else if( command==procVerboseCmd )
  {
    // Command  /process/setVerbose
    G4Tokenizer next( newValue );
 
    // check 1st argument
    G4String tmpS = G4String(next());
    //  inputstream for newValues
    const char* temp = (const char*)(tmpS);
    std::istringstream is((char*)temp);
    G4int level;
    is  >>level;
 
    // check 2nd argument
    currentProcessTypeName = G4String(next());
    if (currentProcessTypeName.empty()) currentProcessTypeName = "all";
    G4bool isProcName = false;
    G4bool isAll = false;
    type = -1;
 
    if (currentProcessTypeName == "all")
    {
      isAll = true; 
    }
    else
    {
      type  = GetProcessType(currentProcessTypeName);
      if (type<0)
      {
        isProcName = true;
        currentProcessName = currentProcessTypeName;
        currentProcessTypeName = "";
      }
    }  
    for (auto itr=procNameVector->cbegin(); itr!=procNameVector->cend(); ++itr)
    {
      G4ProcessVector* tmpVector = theProcessTable->FindProcesses(*itr);
      G4VProcess* p = (*tmpVector)(0);
      if ( isAll || 
           (!isProcName && ( p->GetProcessType() == type) ) ||
           ( isProcName && ( p->GetProcessName()== currentProcessName) ) )
      {
        p->SetVerboseLevel(level);
      }
      delete tmpVector;
    }
  }
  else if( command==verboseCmd )
  {
    // Command   /process/verbose
    theProcessTable->SetVerboseLevel(verboseCmd->GetNewIntValue(newValue));
  }
  else
  {
    G4Tokenizer next( newValue );
 
    // check 1st argument
    currentProcessName = G4String(next());
    G4bool isProcName = false; 
    for (auto itr=procNameVector->cbegin(); itr!=procNameVector->cend(); ++itr)
    {
      if ( (*itr) == currentProcessName )
      {
        isProcName = true; 
        break;
      }
    }
    if (!isProcName)
    {
      type  = GetProcessType(currentProcessName);
      if (type <0 )
      {
        // no processes with specified name
        ed << " illegal process (or type) name ["
           << currentProcessName << "]";
        command->CommandFailed(ed);
        currentProcessName = "";
        return;
      }
    }
  
    // check 2nd argument
    currentParticleName = G4String(next());
    G4bool isParticleFound = false;
    G4ParticleDefinition* currentParticle = nullptr;
    if ( currentParticleName == "all" )
    {
      isParticleFound = true;
    }
    else
    {
      isParticleFound = G4ParticleTable::GetParticleTable()
                      ->contains(currentParticleName);
      if (isParticleFound)
      {
        currentParticle = G4ParticleTable::GetParticleTable()
                        ->FindParticle(currentParticleName);
      }
    }
 
    if ( !isParticleFound )
    {
      // no particle with specified name
      ed << " illegal particle name [" << currentParticleName << "]";
      command->CommandFailed(ed);
      currentParticleName = "";
      return;
    }
        
    if( command==dumpCmd )
    {
      // process/dump
      G4ProcessVector* tmpVector;
      if (isProcName)
      {
        tmpVector = theProcessTable->FindProcesses(currentProcessName);
      }
      else
      {
        tmpVector = theProcessTable->FindProcesses(G4ProcessType(type));
      }
      for (G4int i=0; i<(G4int)tmpVector->length(); ++i)
      {
        theProcessTable->DumpInfo( (*tmpVector)(i), currentParticle );
      }
      delete tmpVector;
    }
    else if ( (command==activateCmd) || (command==inactivateCmd))
    {
      // process/activate , inactivate
      G4bool fActive = (command==activateCmd);
      if (isProcName)
      {
        if ( currentParticle == nullptr )
        {
          theProcessTable->SetProcessActivation(currentProcessName, 
                                                fActive);
        }
        else
        {
          theProcessTable->SetProcessActivation(currentProcessName,
                                                currentParticle,
                                                fActive);
        }
      }
      else
      {
        if ( currentParticle == nullptr )
        {
          theProcessTable->SetProcessActivation(G4ProcessType(type),
                                                fActive);
        }
        else
        {
          theProcessTable->SetProcessActivation(G4ProcessType(type),
                                                currentParticle,
                                                fActive);
        }
      }
      G4UImanager::GetUIpointer()->ApplyCommand("/run/physicsModified");
    } 
  }
}

---

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

• G4ProcessTableMessenger.hh
• G4ProcessTableMessenger.cc