G4ParticlePropertyMessenger Class Reference

#include <G4ParticlePropertyMessenger.hh>

Inheritance diagram for G4ParticlePropertyMessenger:

Public Member Functions
	G4ParticlePropertyMessenger (G4ParticleTable *pTable=nullptr)
virtual	~G4ParticlePropertyMessenger ()
	G4ParticlePropertyMessenger (const G4ParticlePropertyMessenger &)=delete
G4ParticlePropertyMessenger &	operator= (const G4ParticlePropertyMessenger &)=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 ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	operator!= (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
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 (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 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);
}

~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;
} 

G4ParticlePropertyMessenger() [2/2]

G4ParticlePropertyMessenger::G4ParticlePropertyMessenger ( const G4ParticlePropertyMessenger &  )

delete

Member Function Documentation

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;
}

operator=()

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

delete

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));
  }
}

---

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

• G4ParticlePropertyMessenger.hh
• G4ParticlePropertyMessenger.cc