G4DecayTableMessenger Class Reference

#include <G4DecayTableMessenger.hh>

Inheritance diagram for G4DecayTableMessenger:

Public Member Functions
	G4DecayTableMessenger (G4ParticleTable *pTable=nullptr)
virtual	~G4DecayTableMessenger ()
virtual void	SetNewValue (G4UIcommand *command, G4String newValues)
virtual G4String	GetCurrentValue (G4UIcommand *command)
	G4DecayTableMessenger (const G4DecayTableMessenger &)=delete
G4DecayTableMessenger &	operator= (const G4DecayTableMessenger &)=delete
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	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 (G4String s)
G4long	StoL (G4String s)
G4double	StoD (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 57 of file G4DecayTableMessenger.hh.

Constructor & Destructor Documentation

G4DecayTableMessenger() [1/2]

G4DecayTableMessenger::G4DecayTableMessenger

(

G4ParticleTable *

pTable = nullptr

)

Definition at line 44 of file G4DecayTableMessenger.cc.

  : theParticleTable(pTable)
{
  if ( theParticleTable == nullptr )
  {
    theParticleTable = G4ParticleTable::GetParticleTable();
  }
  currentParticle = nullptr;
 
  // Command /particle/property/decay/
  thisDirectory = new G4UIdirectory("/particle/property/decay/");
  thisDirectory->SetGuidance("Decay Table control commands.");
 
  // Command /particle/property/decay/select
  selectCmd = new G4UIcmdWithAnInteger("/particle/property/decay/select",this);
  selectCmd->SetGuidance("Enter index of decay mode.");
  selectCmd->SetParameterName("mode", true);
  selectCmd->SetDefaultValue(0);
  selectCmd->SetRange("mode >=0");
  currentChannel = nullptr;
 
  // Command /particle/property/decay/dump
  dumpCmd = new G4UIcmdWithoutParameter("/particle/property/decay/dump",this);
  dumpCmd->SetGuidance("Dump decay mode information.");
 
  // Command /particle/property/decay/br
  brCmd = new G4UIcmdWithADouble("/particle/property/decay/br",this);
  brCmd->SetGuidance("Set branching ratio. [0< BR <1.0]");
  brCmd->SetParameterName("br",false);
  brCmd->SetRange("(br >=0.0) && (br <=1.0)");
}

~G4DecayTableMessenger()

G4DecayTableMessenger::~G4DecayTableMessenger ( )

virtual

Definition at line 76 of file G4DecayTableMessenger.cc.

{
  if (dumpCmd != nullptr) delete dumpCmd;
  if (selectCmd != nullptr) delete selectCmd;
  if (brCmd != nullptr) delete brCmd;
  if (thisDirectory != nullptr) delete thisDirectory;
}

G4DecayTableMessenger() [2/2]

G4DecayTableMessenger::G4DecayTableMessenger ( const G4DecayTableMessenger &  )

delete

Member Function Documentation

GetCurrentValue()

G4String G4DecayTableMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 190 of file G4DecayTableMessenger.cc.

{
  G4String returnValue('\0');
 
  if (SetCurrentParticle() == nullptr)
  {
    // no particle is selected. return null 
    return returnValue;
  }
 
  if( command == selectCmd )
  {
    // Command /particle/property/decay/select
    returnValue = selectCmd->ConvertToString(idxCurrentChannel);
 
  }
  else if( command == brCmd )
  {
    if ( currentChannel != nullptr)
    {
      returnValue = brCmd->ConvertToString(currentChannel->GetBR());
    } 
  }
  return returnValue;
}

operator=()

G4DecayTableMessenger & G4DecayTableMessenger::operator= ( const G4DecayTableMessenger &  )

delete

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 84 of file G4DecayTableMessenger.cc.

{
  if (SetCurrentParticle()== nullptr)
  {
    G4cout << "Particle is not selected yet !! Command ignored." << G4endl;
    return;
  }
  if (currentDecayTable== nullptr)
  {
    G4cout << "The particle has no decay table !! Command ignored." << G4endl;
    return;
  }
 
  if( command == dumpCmd )
  {
    // Command /particle/property/decay/dump
    currentDecayTable->DumpInfo();
 
  }
  else if ( command == selectCmd )
  {
    // Command /particle/property/decay/select
    G4int index = selectCmd->GetNewIntValue(newValue) ;
    currentChannel = currentDecayTable->GetDecayChannel(index);
    if ( currentChannel == nullptr )
    {
      G4cout << "Invalid index. Command ignored." << G4endl;
    }
    else
    {
      idxCurrentChannel = index;
    }
 
  }
  else
  {
    if ( currentChannel == nullptr )
    {
      G4cout << "Select a decay channel. Command ignored." << G4endl;
      return;
    }
    if (command == brCmd)
    {
      // Command /particle/property/decay/br
      G4double  br = brCmd->GetNewDoubleValue(newValue);
      if( (br<0.0) || (br>1.0) )
      { 
        G4cout << "Invalid brancing ratio. Command ignored." << G4endl;
      }
      else
      {
        currentChannel->SetBR(br);
      }
    }
  }
}

---

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

• G4DecayTableMessenger.hh
• G4DecayTableMessenger.cc