G4ParticlePropertyMessenger Class Reference

#include <G4ParticlePropertyMessenger.hh>

Inheritance diagram for G4ParticlePropertyMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const
	G4ParticlePropertyMessenger (const G4ParticlePropertyMessenger &)=delete
	G4ParticlePropertyMessenger (G4ParticleTable *pTable=nullptr)
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	operator!= (const G4UImessenger &messenger) const
G4ParticlePropertyMessenger &	operator= (const G4ParticlePropertyMessenger &)=delete
G4bool	operator== (const G4UImessenger &messenger) const
virtual void	SetNewValue (G4UIcommand *command, G4String newValues)
virtual	~G4ParticlePropertyMessenger ()

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 *	dumpCmd = nullptr
G4DecayTableMessenger *	fDecayTableMessenger = nullptr
G4UIcmdWithADoubleAndUnit *	lifetimeCmd = nullptr
G4UIcmdWithABool *	stableCmd = nullptr
G4ParticleTable *	theParticleTable = nullptr
G4UIdirectory *	thisDirectory = nullptr
G4UIcmdWithAnInteger *	verboseCmd = nullptr

Detailed Description

Definition at line 58 of file G4ParticlePropertyMessenger.hh.

Constructor & Destructor Documentation

G4ParticlePropertyMessenger() [1/2]

G4ParticlePropertyMessenger::G4ParticlePropertyMessenger

(

G4ParticleTable *

pTable = nullptr

)

Definition at line 46 of file G4ParticlePropertyMessenger.cc.

  : theParticleTable(pTable)
{
  if ( theParticleTable == nullptr)
    theParticleTable = G4ParticleTable::GetParticleTable();
 
  // Command   /particle/property/
  thisDirectory = new G4UIdirectory("/particle/property/");
  thisDirectory->SetGuidance("Particle Table control commands.");
 
  // Command   /particle/property/dump
  dumpCmd = new G4UIcmdWithoutParameter("/particle/property/dump",this);
  dumpCmd->SetGuidance("Dump particle properties.");
 
  // Command   /particle/property/stable
  stableCmd = new G4UIcmdWithABool("/particle/property/stable",this);
  stableCmd->SetGuidance("Set stable flag.");
  stableCmd->SetGuidance("  false: Unstable   true: Stable");
  stableCmd->SetParameterName("stable",false);
  stableCmd->AvailableForStates(G4State_PreInit,G4State_Idle,G4State_GeomClosed);
 
  // Command   /particle/property/lifetime
  lifetimeCmd = new G4UIcmdWithADoubleAndUnit("/particle/property/lifetime",this);
  lifetimeCmd->SetGuidance("Set life time.");
  lifetimeCmd->SetGuidance("Unit of the time can be :");
  lifetimeCmd->SetGuidance(" s, ms, ns (default)");
  lifetimeCmd->SetParameterName("life",false);
  lifetimeCmd->SetDefaultValue(0.0);
  lifetimeCmd->SetRange("life >0.0");
  //lifetimeCmd->SetUnitCategory("Time");
  //lifetimeCmd->SetUnitCandidates("s ms ns");
  lifetimeCmd->SetDefaultUnit("ns");
  lifetimeCmd->AvailableForStates(G4State_PreInit,G4State_Idle,G4State_GeomClosed);
 
  // -- particle/property/Verbose ---
  verboseCmd = new G4UIcmdWithAnInteger("/particle/property/verbose",this);
  verboseCmd->SetGuidance("Set Verbose level of particle property.");
  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 Decay Table
  fDecayTableMessenger = new G4DecayTableMessenger(theParticleTable);
}

References G4UIcommand::AvailableForStates(), dumpCmd, fDecayTableMessenger, G4State_GeomClosed, G4State_Idle, G4State_PreInit, G4ParticleTable::GetParticleTable(), lifetimeCmd, G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultValue(), G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcommand::SetGuidance(), G4UIcmdWithABool::SetParameterName(), G4UIcmdWithADoubleAndUnit::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcommand::SetRange(), stableCmd, theParticleTable, thisDirectory, and verboseCmd.

~G4ParticlePropertyMessenger()

G4ParticlePropertyMessenger::~G4ParticlePropertyMessenger ( )

virtual

Definition at line 95 of file G4ParticlePropertyMessenger.cc.

{
  delete fDecayTableMessenger;
  fDecayTableMessenger = nullptr;
 
  delete stableCmd; 
  delete verboseCmd;
  delete lifetimeCmd;
  delete dumpCmd;
  delete thisDirectory;
} 

References dumpCmd, fDecayTableMessenger, lifetimeCmd, stableCmd, thisDirectory, and verboseCmd.

G4ParticlePropertyMessenger() [2/2]

G4ParticlePropertyMessenger::G4ParticlePropertyMessenger ( const G4ParticlePropertyMessenger &  )

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

virtual

Reimplemented from G4UImessenger.

Definition at line 155 of file G4ParticlePropertyMessenger.cc.

{
  G4String returnValue(1,'\0');
 
  const G4ParticleDefinition* currentParticle = theParticleTable->GetSelectedParticle();
  if ( currentParticle == nullptr )
  {
    return returnValue;  // no particle is selected. return null 
  }
 
  if( command == stableCmd )
  {
    // Command   /particle/property/stable
    returnValue = stableCmd->ConvertToString( currentParticle->GetPDGStable());
  }
  else if( command == lifetimeCmd )
  {
    // Command   /particle/property/lifetime
    returnValue = lifetimeCmd->ConvertToString( currentParticle->GetPDGLifeTime(), "ns" );
  }
  else if( command==verboseCmd )
  {
    // Command   /particle/property/Verbose
    returnValue= verboseCmd->ConvertToString(currentParticle->GetVerboseLevel());
  } 
  
  return returnValue;
}

References G4UIcommand::ConvertToString(), G4ParticleDefinition::GetPDGLifeTime(), G4ParticleDefinition::GetPDGStable(), G4ParticleTable::GetSelectedParticle(), G4ParticleDefinition::GetVerboseLevel(), lifetimeCmd, stableCmd, theParticleTable, 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=()

G4ParticlePropertyMessenger & G4ParticlePropertyMessenger::operator= ( const G4ParticlePropertyMessenger &  )

delete

operator==()

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

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 107 of file G4ParticlePropertyMessenger.cc.

{
  G4ParticleDefinition* currentParticle
    = const_cast<G4ParticleDefinition*>(theParticleTable->GetSelectedParticle());
 
  if (currentParticle == nullptr)
  {
    G4cout << "Particle is not selected yet !! Command ignored." << G4endl;
    return;
  }
 
  if( command == dumpCmd )
  {
    // Command   /particle/property/dump
    currentParticle->DumpTable();
 
  }
  else if (command == lifetimeCmd )
  {
    // Command   /particle/property/lifetime
    currentParticle->SetPDGLifeTime(lifetimeCmd->GetNewDoubleValue(newValue));
 
  }
  else if (command == stableCmd )
  {
    // Command   /particle/property/stable
    if (currentParticle->GetPDGLifeTime()<0.0)
    {
      G4cout << "Life time is negative! Command ignored." << G4endl; 
    }
    else if (currentParticle->GetPDGMass()<=0.0)
    {
      G4cout << "Zero Mass! Command ignored." << G4endl; 
    }
    else
    {
      currentParticle->SetPDGStable(stableCmd->GetNewBoolValue(newValue));
    }
  
  }
  else if( command==verboseCmd )
  {
    // Command   /particle/property/Verbose
    currentParticle->SetVerboseLevel(verboseCmd->GetNewIntValue(newValue));
  }
}

References dumpCmd, G4ParticleDefinition::DumpTable(), G4cout, G4endl, G4UIcmdWithABool::GetNewBoolValue(), G4UIcmdWithADoubleAndUnit::GetNewDoubleValue(), G4UIcmdWithAnInteger::GetNewIntValue(), G4ParticleDefinition::GetPDGLifeTime(), G4ParticleDefinition::GetPDGMass(), G4ParticleTable::GetSelectedParticle(), lifetimeCmd, G4ParticleDefinition::SetPDGLifeTime(), G4ParticleDefinition::SetPDGStable(), G4ParticleDefinition::SetVerboseLevel(), stableCmd, theParticleTable, 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().

dumpCmd

G4UIcmdWithoutParameter* G4ParticlePropertyMessenger::dumpCmd = nullptr

private

Definition at line 76 of file G4ParticlePropertyMessenger.hh.

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

fDecayTableMessenger

G4DecayTableMessenger* G4ParticlePropertyMessenger::fDecayTableMessenger = nullptr

private

Definition at line 81 of file G4ParticlePropertyMessenger.hh.

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

lifetimeCmd

G4UIcmdWithADoubleAndUnit* G4ParticlePropertyMessenger::lifetimeCmd = nullptr

private

Definition at line 79 of file G4ParticlePropertyMessenger.hh.

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

stableCmd

G4UIcmdWithABool* G4ParticlePropertyMessenger::stableCmd = nullptr

private

Definition at line 77 of file G4ParticlePropertyMessenger.hh.

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

theParticleTable

G4ParticleTable* G4ParticlePropertyMessenger::theParticleTable = nullptr

private

Definition at line 73 of file G4ParticlePropertyMessenger.hh.

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

thisDirectory

G4UIdirectory* G4ParticlePropertyMessenger::thisDirectory = nullptr

private

Definition at line 75 of file G4ParticlePropertyMessenger.hh.

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

verboseCmd

G4UIcmdWithAnInteger* G4ParticlePropertyMessenger::verboseCmd = nullptr

private

Definition at line 78 of file G4ParticlePropertyMessenger.hh.

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

---

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

• source/particles/management/include/G4ParticlePropertyMessenger.hh
• source/particles/management/src/G4ParticlePropertyMessenger.cc