#include <G4ParticleMessenger.hh>

Inheritance diagram for G4ParticleMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

	G4ParticleMessenger (const G4ParticleMessenger &)=delete

	G4ParticleMessenger (G4ParticleTable *pTable=nullptr)

G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator!= (const G4UImessenger &messenger) const

G4ParticleMessenger &	operator= (const G4ParticleMessenger &)=delete

G4bool	operator== (const G4UImessenger &messenger) const

void	SetNewValue (G4UIcommand *command, G4String newValues)

virtual	~G4ParticleMessenger ()

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 *	createAllIonCmd = nullptr

G4UIcmdWithoutParameter *	createAllIsomerCmd = nullptr

G4ParticleDefinition *	currentParticle = nullptr

G4UIcmdWithAnInteger *	findCmd = nullptr

G4ParticlePropertyMessenger *	fParticlePropertyMessenger = nullptr

G4UIcmdWithAString *	listCmd = nullptr

G4UIcmdWithAString *	selectCmd = nullptr

G4ParticleTable *	theParticleTable = nullptr

G4UIdirectory *	thisDirectory = nullptr

G4UIcmdWithAnInteger *	verboseCmd = nullptr

Detailed Description

Definition at line 75 of file G4ParticleMessenger.hh.

Constructor & Destructor Documentation

◆ G4ParticleMessenger() [1/2]

G4ParticleMessenger::G4ParticleMessenger ( G4ParticleTable * pTable = nullptr )

Definition at line 46 of file G4ParticleMessenger.cc.

{
  // get the pointer to ParticleTable
  if ( pTable == nullptr)
  {
    theParticleTable = G4ParticleTable::GetParticleTable();
  }
  else
  {
    theParticleTable = pTable;
  }
 
  // Directory   /particle/
  thisDirectory = new G4UIdirectory("/particle/");
  thisDirectory->SetGuidance("Particle control commands.");
 
  // Command   /particle/select
  selectCmd = new G4UIcmdWithAString("/particle/select",this);
  selectCmd->SetGuidance("Select particle ");
  selectCmd->SetDefaultValue("none");
  selectCmd->SetParameterName("particle name", false);
  selectCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
 
  // Command   /particle/list
  listCmd = new G4UIcmdWithAString("/particle/list",this);
  listCmd->SetGuidance("List name of particles.");
  listCmd->SetGuidance(" all(default)/lepton/baryon/meson/nucleus/quarks");
  listCmd->SetParameterName("particle type", true);
  listCmd->SetDefaultValue("all");
  listCmd->SetCandidates("all lepton baryon meson nucleus quarks");
  listCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
 
  // Command   /particle/find 
  findCmd = new G4UIcmdWithAnInteger("/particle/find",this);
  findCmd->SetGuidance("Find particle by encoding");
  findCmd->SetDefaultValue(0);
  findCmd->SetParameterName("encoding", false);
  findCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
 
  // Command   /particle/createAllIon
  createAllIonCmd = new G4UIcmdWithoutParameter("/particle/createAllIon",this);
  createAllIonCmd->SetGuidance("Create All ions (ground state)");
  createAllIonCmd->AvailableForStates(G4State_Idle);
  createAllIonCmd->SetToBeBroadcasted(false);
 
  // Command   /particle/createAllIsomer
  createAllIsomerCmd = new G4UIcmdWithoutParameter("/particle/createAllIsomer",this);
  createAllIsomerCmd->SetGuidance("Create All isomers");
  createAllIsomerCmd->AvailableForStates(G4State_Idle);
  createAllIsomerCmd->SetToBeBroadcasted(false);
 
  // -- particle/property/Verbose ---
  verboseCmd = new G4UIcmdWithAnInteger("/particle/verbose",this);
  verboseCmd->SetGuidance("Set Verbose level of particle table.");
  verboseCmd->SetGuidance(" 0 : Silent (default)");
  verboseCmd->SetGuidance(" 1 : Display warning messages");
  verboseCmd->SetGuidance(" 2 : Display more");
  verboseCmd->SetParameterName("verbose_level",true);
  verboseCmd->SetDefaultValue(0);
  verboseCmd->SetRange("verbose_level >=0");
 
  // UI messenger for Particle Properties
  fParticlePropertyMessenger = new G4ParticlePropertyMessenger(theParticleTable);
}

References G4UIcommand::AvailableForStates(), createAllIonCmd, createAllIsomerCmd, findCmd, fParticlePropertyMessenger, G4State_Idle, G4State_PreInit, G4ParticleTable::GetParticleTable(), listCmd, selectCmd, G4UIcmdWithAString::SetCandidates(), G4UIcmdWithAString::SetDefaultValue(), G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcommand::SetGuidance(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWithAString::SetParameterName(), G4UIcommand::SetRange(), G4UIcommand::SetToBeBroadcasted(), theParticleTable, thisDirectory, and verboseCmd.

◆ ~G4ParticleMessenger()

G4ParticleMessenger::~G4ParticleMessenger ( )

virtual

Definition at line 112 of file G4ParticleMessenger.cc.

{
  delete fParticlePropertyMessenger;
 
  delete listCmd; 
  delete selectCmd;
  delete findCmd;
  delete createAllIonCmd;
  delete createAllIsomerCmd;
  delete verboseCmd;
 
  delete thisDirectory;
}

References createAllIonCmd, createAllIsomerCmd, findCmd, fParticlePropertyMessenger, listCmd, selectCmd, thisDirectory, and verboseCmd.

◆ G4ParticleMessenger() [2/2]

G4ParticleMessenger::G4ParticleMessenger ( const G4ParticleMessenger & )

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

virtual

Reimplemented from G4UImessenger.

Definition at line 206 of file G4ParticleMessenger.cc.

{
  if( command==selectCmd )
  {
    // Command  /particle/select
    // set candidate List
    G4String candidates("none");
    G4ParticleTable::G4PTblDicIterator* piter = theParticleTable->GetIterator();
    piter -> reset();
    while( (*piter)() ) // Loop checking, 09.08.2015, K.Kurashige
    {
      G4ParticleDefinition *particle = piter->value();
      candidates += " " + particle->GetParticleName();
    }
    selectCmd->SetCandidates((const char *)(candidates));   
 
    static const G4String noName("none");
    // current value
    if(currentParticle == nullptr)
    {
      // no particle is selected. return null 
      return noName;
    }
    else
    {
      return currentParticle->GetParticleName();
    }
  }
  else if( command==verboseCmd )
  {
    // Command   /particle/verbose
    return verboseCmd->ConvertToString(theParticleTable->GetVerboseLevel());
  }
  return "";
}

References G4UIcommand::ConvertToString(), currentParticle, G4ParticleTable::GetIterator(), G4ParticleDefinition::GetParticleName(), G4ParticleTable::GetVerboseLevel(), selectCmd, G4UIcmdWithAString::SetCandidates(), theParticleTable, G4ParticleTableIterator< K, V >::value(), 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=()

G4ParticleMessenger & G4ParticleMessenger::operator= ( const G4ParticleMessenger & )

delete

◆ operator==()

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

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 127 of file G4ParticleMessenger.cc.

{
  if( command==listCmd )
  {
    // Command   /particle/List
    G4int counter = 0;
    G4ParticleTable::G4PTblDicIterator *piter = theParticleTable->GetIterator();
    piter -> reset();
  
    while( (*piter)() ) // Loop checking, 09.08.2015, K.Kurashige
    {
      G4ParticleDefinition* particle = piter->value();
      if ((newValues=="all") || (newValues==particle->GetParticleType()))
      {
        G4cout << std::setw(19) << particle->GetParticleName();
        if ((counter++)%4 == 3)
        {
          G4cout << G4endl;
        }
        else
        {
          G4cout << ",";
        }
      }
    }
    G4cout << G4endl;
    if (counter == 0)  { G4cout << newValues << " is not found " << G4endl; }
    
    // Command  /particle/select
    // set candidate List
    G4String candidates("none");
    piter -> reset();
    while( (*piter)() ) // Loop checking, 09.08.2015, K.Kurashige
    {
      G4ParticleDefinition* particle = piter->value();
      candidates += " " + particle->GetParticleName();
    }
    selectCmd->SetCandidates((const char *)(candidates));   
 
  }
  else if( command==selectCmd )
  {
    // Command   /particle/select
    theParticleTable->SelectParticle(newValues);
  }
  else if( command==findCmd )
  {
    // Command   /particle/find
    G4ParticleDefinition* tmp
      = theParticleTable->FindParticle( findCmd->GetNewIntValue(newValues));
    if(tmp == nullptr)
    {
      G4cout << "Unknown particle [" << newValues << "]. Command ignored."
             << G4endl;
    }
    else
    {
      G4cout << tmp->GetParticleName() << G4endl;
      tmp->DumpTable();
    }
  }
  else if( command==createAllIonCmd )
  {
    // Command   /particle/createAllIon
    theParticleTable->GetIonTable()->CreateAllIon();
  }
  else if( command==createAllIsomerCmd )
  {
    // Command   /particle/createAllIsomer
    theParticleTable->GetIonTable()->CreateAllIsomer();
  }
  else if( command==verboseCmd )
  {
    // Command   /particle/verbose
    theParticleTable->SetVerboseLevel(verboseCmd->GetNewIntValue(newValues));
  }    
}

References G4IonTable::CreateAllIon(), createAllIonCmd, G4IonTable::CreateAllIsomer(), createAllIsomerCmd, G4ParticleDefinition::DumpTable(), findCmd, G4ParticleTable::FindParticle(), G4cout, G4endl, G4ParticleTable::GetIonTable(), G4ParticleTable::GetIterator(), G4UIcmdWithAnInteger::GetNewIntValue(), G4ParticleDefinition::GetParticleName(), G4ParticleDefinition::GetParticleType(), listCmd, selectCmd, G4ParticleTable::SelectParticle(), G4UIcmdWithAString::SetCandidates(), G4ParticleTable::SetVerboseLevel(), theParticleTable, G4ParticleTableIterator< K, V >::value(), 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

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

◆ createAllIonCmd

G4UIcmdWithoutParameter* G4ParticleMessenger::createAllIonCmd = nullptr

private

Definition at line 94 of file G4ParticleMessenger.hh.

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

◆ createAllIsomerCmd

G4UIcmdWithoutParameter* G4ParticleMessenger::createAllIsomerCmd = nullptr

private

Definition at line 95 of file G4ParticleMessenger.hh.

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

◆ currentParticle

G4ParticleDefinition* G4ParticleMessenger::currentParticle = nullptr

private

Definition at line 99 of file G4ParticleMessenger.hh.

Referenced by GetCurrentValue().

◆ findCmd

G4UIcmdWithAnInteger* G4ParticleMessenger::findCmd = nullptr

private

Definition at line 93 of file G4ParticleMessenger.hh.

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

◆ fParticlePropertyMessenger

G4ParticlePropertyMessenger* G4ParticleMessenger::fParticlePropertyMessenger = nullptr

private

Definition at line 101 of file G4ParticleMessenger.hh.

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

◆ listCmd

G4UIcmdWithAString* G4ParticleMessenger::listCmd = nullptr

private

Definition at line 91 of file G4ParticleMessenger.hh.

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

◆ selectCmd

G4UIcmdWithAString* G4ParticleMessenger::selectCmd = nullptr

private

Definition at line 92 of file G4ParticleMessenger.hh.

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

◆ theParticleTable

G4ParticleTable* G4ParticleMessenger::theParticleTable = nullptr

private

Definition at line 98 of file G4ParticleMessenger.hh.

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

◆ thisDirectory

G4UIdirectory* G4ParticleMessenger::thisDirectory = nullptr

private

Definition at line 90 of file G4ParticleMessenger.hh.

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

◆ verboseCmd

G4UIcmdWithAnInteger* G4ParticleMessenger::verboseCmd = nullptr

private

Definition at line 96 of file G4ParticleMessenger.hh.

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

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

source/particles/management/include/G4ParticleMessenger.hh
source/particles/management/src/G4ParticleMessenger.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4ParticleMessenger() [1/2]

◆ ~G4ParticleMessenger()

◆ G4ParticleMessenger() [2/2]

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Field Documentation

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster

◆ createAllIonCmd

◆ createAllIsomerCmd

◆ currentParticle

◆ findCmd

◆ fParticlePropertyMessenger

◆ listCmd

◆ selectCmd

◆ theParticleTable

◆ thisDirectory

◆ verboseCmd