#include <G4DecayTableMessenger.hh>

Inheritance diagram for G4DecayTableMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

	G4DecayTableMessenger (const G4DecayTableMessenger &)=delete

	G4DecayTableMessenger (G4ParticleTable *pTable=nullptr)

virtual G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator!= (const G4UImessenger &messenger) const

G4DecayTableMessenger &	operator= (const G4DecayTableMessenger &)=delete

G4bool	operator== (const G4UImessenger &messenger) const

virtual void	SetNewValue (G4UIcommand *command, G4String newValues)

virtual	~G4DecayTableMessenger ()

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 Member Functions
G4ParticleDefinition *	SetCurrentParticle ()

Private Attributes
G4UIcmdWithADouble *	brCmd = nullptr

G4VDecayChannel *	currentChannel = nullptr

G4DecayTable *	currentDecayTable = nullptr

G4ParticleDefinition *	currentParticle = nullptr

G4UIcmdWithoutParameter *	dumpCmd = nullptr

G4int	idxCurrentChannel = -1

G4UIcmdWithAnInteger *	selectCmd = nullptr

G4ParticleTable *	theParticleTable = nullptr

G4UIdirectory *	thisDirectory = nullptr

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

References brCmd, currentChannel, currentParticle, dumpCmd, G4ParticleTable::GetParticleTable(), selectCmd, G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcommand::SetGuidance(), G4UIcmdWithADouble::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcommand::SetRange(), theParticleTable, and thisDirectory.

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

References brCmd, dumpCmd, selectCmd, and thisDirectory.

◆ G4DecayTableMessenger() [2/2]

G4DecayTableMessenger::G4DecayTableMessenger ( const G4DecayTableMessenger & )

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

virtual

Reimplemented from G4UImessenger.

Definition at line 190 of file G4DecayTableMessenger.cc.

{
  G4String returnValue(1,'\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;
}

References brCmd, G4UIcommand::ConvertToString(), currentChannel, G4VDecayChannel::GetBR(), idxCurrentChannel, selectCmd, and SetCurrentParticle().

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

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

delete

◆ operator==()

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

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetCurrentParticle()

G4ParticleDefinition * G4DecayTableMessenger::SetCurrentParticle ( )

private

Definition at line 142 of file G4DecayTableMessenger.cc.

{
  // set currentParticle pointer  
  // get particle name by asking G4ParticleMessenger via UImanager
 
  G4String particleName
    = G4UImanager::GetUIpointer()->GetCurrentStringValue("/particle/select");
 
  if (currentParticle != nullptr )
  {
    // check whether selection is changed 
    if (currentParticle->GetParticleName() != particleName)
    {
      currentParticle = theParticleTable->FindParticle(particleName);
      idxCurrentChannel = -1;
      currentDecayTable = nullptr;
    }
    else
    {
      // no change 
      return currentParticle;
    }
 
  }
  else
  {
    currentParticle = theParticleTable->FindParticle(particleName);
    idxCurrentChannel = -1;
    currentDecayTable = nullptr;
  }
 
  if (currentParticle != nullptr )
  {
    currentDecayTable = currentParticle->GetDecayTable();
    if ( (currentDecayTable != nullptr ) && (idxCurrentChannel >0) )
    {
      currentChannel = currentDecayTable->GetDecayChannel(idxCurrentChannel);
    }
    else
    {
      idxCurrentChannel = -1;
      currentChannel = nullptr;
    }
  }
 
  return currentParticle;
}

References currentChannel, currentDecayTable, currentParticle, G4ParticleTable::FindParticle(), G4UImanager::GetCurrentStringValue(), G4DecayTable::GetDecayChannel(), G4ParticleDefinition::GetDecayTable(), G4ParticleDefinition::GetParticleName(), G4UImanager::GetUIpointer(), idxCurrentChannel, and theParticleTable.

Referenced by GetCurrentValue(), and SetNewValue().

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

References brCmd, currentChannel, currentDecayTable, dumpCmd, G4DecayTable::DumpInfo(), G4cout, G4endl, G4DecayTable::GetDecayChannel(), G4UIcmdWithADouble::GetNewDoubleValue(), G4UIcmdWithAnInteger::GetNewIntValue(), idxCurrentChannel, selectCmd, G4VDecayChannel::SetBR(), and SetCurrentParticle().

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

◆ brCmd

G4UIcmdWithADouble* G4DecayTableMessenger::brCmd = nullptr

private

Definition at line 82 of file G4DecayTableMessenger.hh.

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

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protectedinherited

Definition at line 104 of file G4UImessenger.hh.

Referenced by G4UImessenger::CommandsShouldBeInMaster(), and G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger().

◆ currentChannel

G4VDecayChannel* G4DecayTableMessenger::currentChannel = nullptr

private

Definition at line 77 of file G4DecayTableMessenger.hh.

Referenced by G4DecayTableMessenger(), GetCurrentValue(), SetCurrentParticle(), and SetNewValue().

◆ currentDecayTable

G4DecayTable* G4DecayTableMessenger::currentDecayTable = nullptr

private

Definition at line 76 of file G4DecayTableMessenger.hh.

Referenced by SetCurrentParticle(), and SetNewValue().

◆ currentParticle

G4ParticleDefinition* G4DecayTableMessenger::currentParticle = nullptr

private

Definition at line 75 of file G4DecayTableMessenger.hh.

Referenced by G4DecayTableMessenger(), and SetCurrentParticle().

◆ dumpCmd

G4UIcmdWithoutParameter* G4DecayTableMessenger::dumpCmd = nullptr

private

Definition at line 80 of file G4DecayTableMessenger.hh.

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

◆ idxCurrentChannel

G4int G4DecayTableMessenger::idxCurrentChannel = -1

private

Definition at line 84 of file G4DecayTableMessenger.hh.

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

◆ selectCmd

G4UIcmdWithAnInteger* G4DecayTableMessenger::selectCmd = nullptr

private

Definition at line 81 of file G4DecayTableMessenger.hh.

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

◆ theParticleTable

G4ParticleTable* G4DecayTableMessenger::theParticleTable = nullptr

private

Definition at line 74 of file G4DecayTableMessenger.hh.

Referenced by G4DecayTableMessenger(), and SetCurrentParticle().

◆ thisDirectory

G4UIdirectory* G4DecayTableMessenger::thisDirectory = nullptr

private

Definition at line 79 of file G4DecayTableMessenger.hh.

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4DecayTableMessenger() [1/2]

◆ ~G4DecayTableMessenger()

◆ G4DecayTableMessenger() [2/2]

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ SetCurrentParticle()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Field Documentation

◆ baseDir

◆ baseDirName

◆ brCmd

◆ commandsShouldBeInMaster

◆ currentChannel

◆ currentDecayTable

◆ currentParticle

◆ dumpCmd

◆ idxCurrentChannel

◆ selectCmd

◆ theParticleTable

◆ thisDirectory