G4ParticleMessenger Class Reference

#include <G4ParticleMessenger.hh>

Inheritance diagram for G4ParticleMessenger:

Collaboration diagram for G4ParticleMessenger:

Public Member Functions
	G4ParticleMessenger (G4ParticleTable *pTable=0)
virtual	~G4ParticleMessenger ()
void	SetNewValue (G4UIcommand *command, G4String newValues)
G4String	GetCurrentValue (G4UIcommand *command)
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Private Member Functions
	G4ParticleMessenger (const G4ParticleMessenger &)

Private Attributes
G4UIdirectory *	thisDirectory
G4UIcmdWithAString *	listCmd
G4UIcmdWithAString *	selectCmd
G4UIcmdWithAnInteger *	findCmd
G4UIcmdWithoutParameter *	createAllIonCmd
G4UIcmdWithoutParameter *	createAllIsomerCmd
G4UIcmdWithAnInteger *	verboseCmd
G4ParticleTable *	theParticleTable
G4ParticleDefinition *	currentParticle
G4ParticlePropertyMessenger *	fParticlePropertyMessenger

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)
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
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

Definition at line 93 of file G4ParticleMessenger.hh.

Constructor & Destructor Documentation

G4ParticleMessenger() [1/2]

G4ParticleMessenger::G4ParticleMessenger

(

G4ParticleTable *

pTable = 0

)

Definition at line 60 of file G4ParticleMessenger.cc.

{
  // get the pointer to ParticleTable
  if ( pTable == 0) {
    theParticleTable = G4ParticleTable::GetParticleTable();
  } else {
    theParticleTable = pTable;
  }
 
  //Directory   /particle/
  thisDirectory = new G4UIdirectory("/particle/");
  thisDirectory->SetGuidance("Particle control commands.");

  //Commnad   /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);

  //Commnad   /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);

  //Commnad   /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);

  //Commnad   /particle/createAllIon
  createAllIonCmd = new G4UIcmdWithoutParameter("/particle/createAllIon",this);
  createAllIonCmd->SetGuidance("Create All ions (ground state)");
  createAllIonCmd->AvailableForStates(G4State_Idle);
  createAllIonCmd->SetToBeBroadcasted(false);

  //Commnad   /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");

  currentParticle = 0;

  //UI messenger for Particle Properties
  fParticlePropertyMessenger = new G4ParticlePropertyMessenger(theParticleTable);

}

Here is the call graph for this function:

~G4ParticleMessenger()

G4ParticleMessenger::~G4ParticleMessenger ( )

virtual

Definition at line 125 of file G4ParticleMessenger.cc.

{
  delete fParticlePropertyMessenger;

  delete listCmd; 
  delete selectCmd;
  delete findCmd;
  delete createAllIonCmd;
  delete createAllIsomerCmd;
  delete verboseCmd;

  delete thisDirectory;
}

G4ParticleMessenger() [2/2]

G4ParticleMessenger::G4ParticleMessenger ( const G4ParticleMessenger &  )

inlineprivate

Definition at line 105 of file G4ParticleMessenger.hh.

:G4UImessenger(){};

Member Function Documentation

GetCurrentValue()

G4String G4ParticleMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 203 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 == 0) {
      // no particle is selected. return null 
      return noName;
    } else {
      return currentParticle->GetParticleName();
    }
  } else if( command==verboseCmd ){
    //Commnad   /particle/verbose
    return verboseCmd->ConvertToString(theParticleTable->GetVerboseLevel());
  }
  return "";
}

Here is the call graph for this function:

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 140 of file G4ParticleMessenger.cc.

{
  if( command==listCmd ){
    //Commnad   /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 ){
    //Commnad   /particle/select
    currentParticle = theParticleTable->FindParticle(newValues);
    if(currentParticle == 0) {
      G4cout << "Unknown particle [" << newValues << "]. Command ignored." << G4endl;
    }   

  } else if( command==findCmd ){
    //Commnad   /particle/find
    G4ParticleDefinition* tmp = theParticleTable->FindParticle( findCmd->GetNewIntValue(newValues));
    if(tmp == 0) {
      G4cout << "Unknown particle [" << newValues << "]. Command ignored." << G4endl;
    } else {
      G4cout << tmp->GetParticleName() << G4endl;
      tmp->DumpTable();
    }

  } else if( command==createAllIonCmd ) {
    //Commnad   /particle/createAllIon
    theParticleTable->GetIonTable()->CreateAllIon();

  } else if( command==createAllIsomerCmd ) {
    //Commnad   /particle/createAllIsomer
    theParticleTable->GetIonTable()->CreateAllIsomer();

  } else if( command==verboseCmd ) {
    //Commnad   /particle/verbose
    theParticleTable->SetVerboseLevel(verboseCmd->GetNewIntValue(newValues));
  }    
}

Here is the call graph for this function:

Member Data Documentation

createAllIonCmd

G4UIcmdWithoutParameter* G4ParticleMessenger::createAllIonCmd

private

Definition at line 112 of file G4ParticleMessenger.hh.

createAllIsomerCmd

G4UIcmdWithoutParameter* G4ParticleMessenger::createAllIsomerCmd

private

Definition at line 113 of file G4ParticleMessenger.hh.

currentParticle

G4ParticleDefinition* G4ParticleMessenger::currentParticle

private

Definition at line 117 of file G4ParticleMessenger.hh.

findCmd

G4UIcmdWithAnInteger* G4ParticleMessenger::findCmd

private

Definition at line 111 of file G4ParticleMessenger.hh.

fParticlePropertyMessenger

G4ParticlePropertyMessenger* G4ParticleMessenger::fParticlePropertyMessenger

private

Definition at line 119 of file G4ParticleMessenger.hh.

listCmd

G4UIcmdWithAString* G4ParticleMessenger::listCmd

private

Definition at line 109 of file G4ParticleMessenger.hh.

selectCmd

G4UIcmdWithAString* G4ParticleMessenger::selectCmd

private

Definition at line 110 of file G4ParticleMessenger.hh.

theParticleTable

G4ParticleTable* G4ParticleMessenger::theParticleTable

private

Definition at line 116 of file G4ParticleMessenger.hh.

thisDirectory

G4UIdirectory* G4ParticleMessenger::thisDirectory

private

Definition at line 105 of file G4ParticleMessenger.hh.

verboseCmd

G4UIcmdWithAnInteger* G4ParticleMessenger::verboseCmd

private

Definition at line 114 of file G4ParticleMessenger.hh.

---

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

• G4ParticleMessenger.hh
• G4ParticleMessenger.cc