G4ParticleGunMessenger Class Reference

#include <G4ParticleGunMessenger.hh>

Inheritance diagram for G4ParticleGunMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const
	G4ParticleGunMessenger (G4ParticleGun *fPtclGun)
G4String	GetCurrentValue (G4UIcommand *command)
G4bool	operator!= (const G4UImessenger &messenger) const
G4bool	operator== (const G4UImessenger &messenger) const
void	SetNewValue (G4UIcommand *command, G4String newValues)
	~G4ParticleGunMessenger ()

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
void	IonCommand (const G4String &newValues)
void	IonLevelCommand (const G4String &newValues)

Private Attributes
G4UIcmdWith3Vector *	directionCmd
G4UIcmdWithADoubleAndUnit *	energyCmd
G4int	fAtomicMass = 0
G4int	fAtomicNumber = 0
G4int	fIonCharge = 0
G4int	fIonEnergyLevel = 0
G4double	fIonExciteEnergy = 0.0
char	fIonFloatingLevelBase = '\0'
G4ParticleGun *	fParticleGun = nullptr
G4bool	fShootIon = false
G4UIdirectory *	gunDirectory
G4UIcommand *	ionCmd
G4UIcommand *	ionLvlCmd
G4UIcmdWithoutParameter *	listCmd
G4UIcmdWithADoubleAndUnit *	momAmpCmd
G4UIcmdWith3VectorAndUnit *	momCmd
G4UIcmdWithAnInteger *	numberCmd
G4UIcmdWithAString *	particleCmd
G4ParticleTable *	particleTable = nullptr
G4UIcmdWith3Vector *	polCmd
G4UIcmdWith3VectorAndUnit *	positionCmd
G4UIcmdWithADoubleAndUnit *	timeCmd

Detailed Description

Definition at line 52 of file G4ParticleGunMessenger.hh.

Constructor & Destructor Documentation

G4ParticleGunMessenger()

G4ParticleGunMessenger::G4ParticleGunMessenger

(

G4ParticleGun *

fPtclGun

)

Definition at line 49 of file G4ParticleGunMessenger.cc.

  : fParticleGun(fPtclGun)
{
  particleTable = G4ParticleTable::GetParticleTable();
 
  gunDirectory = new G4UIdirectory("/gun/");
  gunDirectory->SetGuidance("Particle Gun control commands.");
 
  listCmd = new G4UIcmdWithoutParameter("/gun/List",this);
  listCmd->SetGuidance("List available particles.");
  listCmd->SetGuidance(" Invoke G4ParticleTable.");
 
  particleCmd = new G4UIcmdWithAString("/gun/particle",this);
  particleCmd->SetGuidance("Set particle to be generated.");
  particleCmd->SetGuidance(" (geantino is default)");
  particleCmd->SetGuidance(" (ion can be specified for shooting ions)");
  particleCmd->SetParameterName("particleName",true);
  particleCmd->SetDefaultValue("geantino");
  G4String candidateList; 
  G4ParticleTable::G4PTblDicIterator* itr = particleTable->GetIterator();
  itr->reset();
  while( (*itr)() )
  {
    G4ParticleDefinition* pd = itr->value();
    if( !(pd->IsShortLived()) || pd->GetDecayTable() != nullptr )
    {
      candidateList += pd->GetParticleName();
      candidateList += " ";
    }
  }
  candidateList += "ion ";
  particleCmd->SetCandidates(candidateList);
 
  directionCmd = new G4UIcmdWith3Vector("/gun/direction",this);
  directionCmd->SetGuidance("Set momentum direction.");
  directionCmd->SetGuidance(" Direction needs not to be a unit vector.");
  directionCmd->SetParameterName("ex","ey","ez",true,true); 
  directionCmd->SetRange("ex != 0 || ey != 0 || ez != 0");
  
  energyCmd = new G4UIcmdWithADoubleAndUnit("/gun/energy",this);
  energyCmd->SetGuidance("Set kinetic energy.");
  energyCmd->SetParameterName("Energy",true,true);
  energyCmd->SetDefaultUnit("GeV");
  //energyCmd->SetUnitCategory("Energy");
  //energyCmd->SetUnitCandidates("eV keV MeV GeV TeV");
 
  momCmd = new G4UIcmdWith3VectorAndUnit("/gun/momentum",this);
  momCmd->SetGuidance("Set momentum. This command is equivalent to two commands");
  momCmd->SetGuidance(" /gun/direction and /gun/momentumAmp");
  momCmd->SetParameterName("px","py","pz",true,true); 
  momCmd->SetRange("px != 0 || py != 0 || pz != 0");
  momCmd->SetDefaultUnit("GeV");
 
  momAmpCmd = new G4UIcmdWithADoubleAndUnit("/gun/momentumAmp",this);
  momAmpCmd->SetGuidance("Set absolute value of momentum.");
  momAmpCmd->SetGuidance(" Direction should be set by /gun/direction command.");
  momAmpCmd->SetGuidance(" This command should be used alternatively with /gun/energy.");
  momAmpCmd->SetParameterName("Momentum",true,true);
  momAmpCmd->SetDefaultUnit("GeV");
 
  positionCmd = new G4UIcmdWith3VectorAndUnit("/gun/position",this);
  positionCmd->SetGuidance("Set starting position of the particle.");
  positionCmd->SetParameterName("X","Y","Z",true,true);
  positionCmd->SetDefaultUnit("cm");
  // positionCmd->SetUnitCategory("Length");
  // positionCmd->SetUnitCandidates("microm mm cm m km");
 
  timeCmd = new G4UIcmdWithADoubleAndUnit("/gun/time",this);
  timeCmd->SetGuidance("Set initial time of the particle.");
  timeCmd->SetParameterName("t0",true,true);
  timeCmd->SetDefaultUnit("ns");
  // timeCmd->SetUnitCategory("Time");
  // timeCmd->SetUnitCandidates("ns ms s");
  
  polCmd = new G4UIcmdWith3Vector("/gun/polarization",this);
  polCmd->SetGuidance("Set polarization.");
  polCmd->SetParameterName("Px","Py","Pz",true,true); 
  polCmd->SetRange("Px>=-1.&&Px<=1.&&Py>=-1.&&Py<=1.&&Pz>=-1.&&Pz<=1.");
 
  numberCmd = new G4UIcmdWithAnInteger("/gun/number",this);
  numberCmd->SetGuidance("Set number of particles to be generated.");
  numberCmd->SetParameterName("N",true,true);
  numberCmd->SetRange("N>0");
 
  ionCmd = new G4UIcommand("/gun/ion",this);
  ionCmd->SetGuidance("Set properties of ion to be generated.");
  ionCmd->SetGuidance("[usage] /gun/ion Z A [Q E flb]");
  ionCmd->SetGuidance("        Z:(int) AtomicNumber");
  ionCmd->SetGuidance("        A:(int) AtomicMass");
  ionCmd->SetGuidance("        Q:(int) Charge of Ion (in unit of e)");
  ionCmd->SetGuidance("        E:(double) Excitation energy (in keV)");
  ionCmd->SetGuidance("        flb:(char) Floating level base");
  
  G4UIparameter* param;
  param = new G4UIparameter("Z",'i',false);
  ionCmd->SetParameter(param);
  param = new G4UIparameter("A",'i',false);
  ionCmd->SetParameter(param);
  param = new G4UIparameter("Q",'i',true);
  param->SetDefaultValue(-1);
  ionCmd->SetParameter(param);
  param = new G4UIparameter("E",'d',true);
  param->SetDefaultValue(0.0);
  ionCmd->SetParameter(param);
  param = new G4UIparameter("flb",'c',true);
  param->SetDefaultValue("noFloat");
  param->SetParameterCandidates("noFloat X Y Z U V W R S T A B C D E");
  ionCmd->SetParameter(param);
 
  ionLvlCmd = new G4UIcommand("/gun/ionL",this);
  ionLvlCmd->SetGuidance("THIS COMMAND IS DEPRECATED and will be removed in future releases.");
  ionLvlCmd->SetGuidance(" Use /gun/ion instead.");
  ionLvlCmd->SetGuidance(" Set properties of ion to be generated.");
  ionLvlCmd->SetGuidance(" [usage] /gun/ionL Z A [Q I]");
  ionLvlCmd->SetGuidance("        Z:(int) AtomicNumber");
  ionLvlCmd->SetGuidance("        A:(int) AtomicMass");
  ionLvlCmd->SetGuidance("        Q:(int) Charge of Ion (in unit of e)");
  ionLvlCmd->SetGuidance("        I:(int) Level number of metastable state (0 = ground)");
 
  G4UIparameter* paraml;
  paraml = new G4UIparameter("Z",'i',false);
  ionLvlCmd->SetParameter(paraml);
  paraml = new G4UIparameter("A",'i',false);
  ionLvlCmd->SetParameter(paraml);
  paraml = new G4UIparameter("Q",'i',true);
  paraml->SetDefaultValue(-1);
  ionLvlCmd->SetParameter(paraml);
  paraml = new G4UIparameter("I",'i',true);
  paraml->SetDefaultValue("0");
  ionLvlCmd->SetParameter(paraml);
 
  // Set initial value to G4ParticleGun
  //
  fParticleGun->SetParticleDefinition( G4Geantino::Geantino() );
  fParticleGun->SetParticleMomentumDirection( G4ThreeVector(1.0,0.0,0.0) );
  fParticleGun->SetParticleEnergy( 1.0*GeV );
  fParticleGun->SetParticlePosition(G4ThreeVector(0.0*cm, 0.0*cm, 0.0*cm));
  fParticleGun->SetParticleTime( 0.0*ns );
}

References cm, directionCmd, energyCmd, fParticleGun, G4Geantino::Geantino(), G4ParticleDefinition::GetDecayTable(), G4ParticleTable::GetIterator(), G4ParticleDefinition::GetParticleName(), G4ParticleTable::GetParticleTable(), GeV, gunDirectory, ionCmd, ionLvlCmd, G4ParticleDefinition::IsShortLived(), listCmd, momAmpCmd, momCmd, ns, numberCmd, particleCmd, particleTable, polCmd, positionCmd, G4ParticleTableIterator< K, V >::reset(), G4UIcmdWithAString::SetCandidates(), G4UIcmdWith3VectorAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), G4UIcmdWithAString::SetDefaultValue(), G4UIparameter::SetDefaultValue(), G4UIcommand::SetGuidance(), G4UIcommand::SetParameter(), G4UIparameter::SetParameterCandidates(), G4UIcmdWithADoubleAndUnit::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWithAString::SetParameterName(), G4UIcmdWith3Vector::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetParameterName(), G4ParticleGun::SetParticleDefinition(), G4ParticleGun::SetParticleEnergy(), G4ParticleGun::SetParticleMomentumDirection(), G4VPrimaryGenerator::SetParticlePosition(), G4VPrimaryGenerator::SetParticleTime(), G4UIcommand::SetRange(), timeCmd, and G4ParticleTableIterator< K, V >::value().

~G4ParticleGunMessenger()

G4ParticleGunMessenger::~G4ParticleGunMessenger

(

)

Definition at line 189 of file G4ParticleGunMessenger.cc.

{
  delete listCmd;
  delete particleCmd;
  delete directionCmd;
  delete energyCmd;
  delete momCmd;
  delete momAmpCmd;
  delete positionCmd;
  delete timeCmd;
  delete polCmd;
  delete numberCmd;
  delete ionCmd;
  delete ionLvlCmd;
  delete gunDirectory;
}

References directionCmd, energyCmd, gunDirectory, ionCmd, ionLvlCmd, listCmd, momAmpCmd, momCmd, numberCmd, particleCmd, polCmd, positionCmd, and timeCmd.

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

virtual

Reimplemented from G4UImessenger.

Definition at line 283 of file G4ParticleGunMessenger.cc.

{
  G4String cv;
  
  if( command==directionCmd )
  { cv = directionCmd->ConvertToString(fParticleGun->GetParticleMomentumDirection()); }
  else if( command==particleCmd )
  { cv = fParticleGun->GetParticleDefinition()->GetParticleName(); }
  else if( command==energyCmd )
  {
    G4double ene = fParticleGun->GetParticleEnergy();
    if(ene == 0.)
    { G4cerr << " G4ParticleGun:  was defined in terms of momentum." << G4endl; }
    else
    { cv = energyCmd->ConvertToString(ene,"GeV"); }
  }
  else if( command==momCmd || command==momAmpCmd )
  {
    G4double mom = fParticleGun->GetParticleMomentum();
    if(mom == 0.)
    {
      G4cerr << " G4ParticleGun:  was defined in terms of kinetic energy."
             << G4endl;
    }
    else
    {
      if( command==momCmd )
      { cv = momCmd->ConvertToString(mom*(fParticleGun->GetParticleMomentumDirection()),"GeV"); }
      else
      { cv = momAmpCmd->ConvertToString(mom,"GeV"); }
    }
  }
  else if( command==positionCmd )
  { cv = positionCmd->ConvertToString(fParticleGun->GetParticlePosition(),"cm"); }
  else if( command==timeCmd )
  { cv = timeCmd->ConvertToString(fParticleGun->GetParticleTime(),"ns"); }
  else if( command==polCmd )
  { cv = polCmd->ConvertToString(fParticleGun->GetParticlePolarization()); }
  else if( command==numberCmd )
  { cv = numberCmd->ConvertToString(fParticleGun->GetNumberOfParticles()); }
  else if( command==ionCmd )
  { 
    if (fShootIon)
    {
      cv = ItoS(fAtomicNumber) + " " + ItoS(fAtomicMass) + " ";
      cv += ItoS(fIonCharge);
    }
    else
    {
      cv = "";
    }  
  }    
  return cv;
}

References G4UIcommand::ConvertToString(), directionCmd, energyCmd, fAtomicMass, fAtomicNumber, fIonCharge, fParticleGun, fShootIon, G4cerr, G4endl, G4ParticleGun::GetNumberOfParticles(), G4ParticleGun::GetParticleDefinition(), G4ParticleGun::GetParticleEnergy(), G4ParticleGun::GetParticleMomentum(), G4ParticleGun::GetParticleMomentumDirection(), G4ParticleDefinition::GetParticleName(), G4ParticleGun::GetParticlePolarization(), G4VPrimaryGenerator::GetParticlePosition(), G4VPrimaryGenerator::GetParticleTime(), ionCmd, G4UImessenger::ItoS(), momAmpCmd, momCmd, numberCmd, particleCmd, polCmd, positionCmd, and timeCmd.

IonCommand()

void G4ParticleGunMessenger::IonCommand ( const G4String &  newValues )

private

Definition at line 380 of file G4ParticleGunMessenger.cc.

{
  G4Tokenizer next( newValues );
 
  // Check argument
  //
  fAtomicNumber = StoI(next());
  fAtomicMass = StoI(next());
  fIonCharge = fAtomicNumber;
  fIonExciteEnergy = 0.0;
  fIonFloatingLevelBase = '\0';
  G4String sQ = next();
  if (!(sQ.empty()))
  {
    if (StoI(sQ)>=0)
    fIonCharge = StoI(sQ);
 
    sQ = next();
    if (!(sQ.empty()))
    {
      fIonExciteEnergy = StoD(sQ) * keV;
 
      sQ = next();
      if (sQ.empty()||sQ=="noFloat")
      { fIonFloatingLevelBase = '\0'; }
      else
      { fIonFloatingLevelBase = sQ[(std::size_t)0]; }
    }
  }
  G4ParticleDefinition* ion = G4IonTable::GetIonTable()
    ->GetIon(fAtomicNumber,fAtomicMass,fIonExciteEnergy,fIonFloatingLevelBase);
  if (ion==nullptr)
  {
    G4ExceptionDescription ed;
    ed << "Ion with Z=" << fAtomicNumber;
    ed << " A=" << fAtomicMass << "is not defined";    
    ionCmd->CommandFailed(ed);
  }
  else
  {
    fParticleGun->SetParticleDefinition(ion);
    fParticleGun->SetParticleCharge(fIonCharge*eplus);
  }
}

References G4UIcommand::CommandFailed(), eplus, fAtomicMass, fAtomicNumber, fIonCharge, fIonExciteEnergy, fIonFloatingLevelBase, fParticleGun, G4IonTable::GetIon(), G4IonTable::GetIonTable(), ionCmd, keV, G4ParticleGun::SetParticleCharge(), G4ParticleGun::SetParticleDefinition(), G4UImessenger::StoD(), and G4UImessenger::StoI().

Referenced by SetNewValue().

IonLevelCommand()

void G4ParticleGunMessenger::IonLevelCommand ( const G4String &  newValues )

private

Definition at line 338 of file G4ParticleGunMessenger.cc.

{
  G4Tokenizer next( newValues );
 
  // Check argument
  //
  fAtomicNumber = StoI(next());
  fAtomicMass = StoI(next());
  G4String sQ = next();
  if (sQ.empty() || StoI(sQ)<0)
  {
    fIonCharge = fAtomicNumber;
  }
  else
  {
    fIonCharge = StoI(sQ);
  }
  sQ = next();
  if (sQ.empty())
  {
    fIonEnergyLevel = 0;
  }
  else
  {
    fIonEnergyLevel = StoI(sQ);
  }
  G4ParticleDefinition* ion = G4IonTable::GetIonTable()
      ->GetIon(fAtomicNumber,fAtomicMass,fIonEnergyLevel);
  if (ion == nullptr)
  {
    G4ExceptionDescription ed;
    ed << "Ion with Z = " << fAtomicNumber << ", A = " << fAtomicMass
       << ", I = " << fIonEnergyLevel << " is not defined ";
    ionLvlCmd->CommandFailed(ed);
  }
  else
  {
    fParticleGun->SetParticleDefinition(ion);
    fParticleGun->SetParticleCharge(fIonCharge*eplus);
  }
}

References G4UIcommand::CommandFailed(), eplus, fAtomicMass, fAtomicNumber, fIonCharge, fIonEnergyLevel, fParticleGun, G4IonTable::GetIon(), G4IonTable::GetIonTable(), ionLvlCmd, G4ParticleGun::SetParticleCharge(), G4ParticleGun::SetParticleDefinition(), and G4UImessenger::StoI().

Referenced by SetNewValue().

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

operator!=()

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

inherited

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

operator==()

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

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 206 of file G4ParticleGunMessenger.cc.

{
  G4ExceptionDescription ed;
  if (command==listCmd)
  {
    particleTable->DumpTable();
  }
  else if (command==particleCmd)
  {
    if (newValues =="ion")
    {
      fShootIon = true;
    }
    else
    {
      fShootIon = false;
      G4ParticleDefinition* pd = particleTable->FindParticle(newValues);
      if(pd != nullptr)
      {
        fParticleGun->SetParticleDefinition( pd );
      }
      else
      {
        ed << "Particle [" << newValues << "] is not found.";
        command->CommandFailed(ed);
      }
    }
 
  } else if( command==directionCmd )
  { fParticleGun->SetParticleMomentumDirection(directionCmd->GetNew3VectorValue(newValues)); }
  else if( command==energyCmd )
  { fParticleGun->SetParticleEnergy(energyCmd->GetNewDoubleValue(newValues)); }
  else if( command==momCmd )
  { fParticleGun->SetParticleMomentum(momCmd->GetNew3VectorValue(newValues)); }
  else if( command==momAmpCmd )
  { fParticleGun->SetParticleMomentum(momAmpCmd->GetNewDoubleValue(newValues)); }
  else if( command==positionCmd )
  { fParticleGun->SetParticlePosition(positionCmd->GetNew3VectorValue(newValues)); }
  else if( command==timeCmd )
  { fParticleGun->SetParticleTime(timeCmd->GetNewDoubleValue(newValues)); }
  else if( command==polCmd )
  { fParticleGun->SetParticlePolarization(polCmd->GetNew3VectorValue(newValues)); }
  else if( command==numberCmd )
  { fParticleGun->SetNumberOfParticles(numberCmd->GetNewIntValue(newValues)); }
  else if( command==ionCmd ) 
  {
    if (fShootIon)
    {
      IonCommand(newValues);
    }
    else
    {
      ed << "Set /gun/particle to ion before using /gun/ion command";
      command->CommandFailed(ed);
    }
  }
  else if( command==ionLvlCmd ) 
  {
    G4ExceptionDescription depWarn; 
    depWarn << "\nCommand /gun/ionL is deprecated and will be removed in future releases.\n"
            << "Use /gun/ion instead.\n";
    G4Exception("G4ParticleGunMessenger::SetNewValue", "IonLWarn",
                JustWarning, depWarn);
 
    if (fShootIon)
    {
      IonLevelCommand(newValues);
    }
    else
    {
      ed << "Set /gun/particle to ion before using /gun/ion command";
      command->CommandFailed(ed);
    }
  }
}

References G4UIcommand::CommandFailed(), directionCmd, G4ParticleTable::DumpTable(), energyCmd, G4ParticleTable::FindParticle(), fParticleGun, fShootIon, G4Exception(), G4UIcmdWith3Vector::GetNew3VectorValue(), G4UIcmdWith3VectorAndUnit::GetNew3VectorValue(), G4UIcmdWithADoubleAndUnit::GetNewDoubleValue(), G4UIcmdWithAnInteger::GetNewIntValue(), ionCmd, IonCommand(), IonLevelCommand(), ionLvlCmd, JustWarning, listCmd, momAmpCmd, momCmd, numberCmd, particleCmd, particleTable, polCmd, positionCmd, G4ParticleGun::SetNumberOfParticles(), G4ParticleGun::SetParticleDefinition(), G4ParticleGun::SetParticleEnergy(), G4ParticleGun::SetParticleMomentum(), G4ParticleGun::SetParticleMomentumDirection(), G4ParticleGun::SetParticlePolarization(), G4VPrimaryGenerator::SetParticlePosition(), G4VPrimaryGenerator::SetParticleTime(), and timeCmd.

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(), 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(), IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), 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().

directionCmd

G4UIcmdWith3Vector* G4ParticleGunMessenger::directionCmd

private

Definition at line 77 of file G4ParticleGunMessenger.hh.

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

energyCmd

G4UIcmdWithADoubleAndUnit* G4ParticleGunMessenger::energyCmd

private

Definition at line 78 of file G4ParticleGunMessenger.hh.

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

fAtomicMass

G4int G4ParticleGunMessenger::fAtomicMass = 0

private

Definition at line 92 of file G4ParticleGunMessenger.hh.

Referenced by GetCurrentValue(), IonCommand(), and IonLevelCommand().

fAtomicNumber

G4int G4ParticleGunMessenger::fAtomicNumber = 0

private

Definition at line 91 of file G4ParticleGunMessenger.hh.

Referenced by GetCurrentValue(), IonCommand(), and IonLevelCommand().

fIonCharge

G4int G4ParticleGunMessenger::fIonCharge = 0

private

Definition at line 93 of file G4ParticleGunMessenger.hh.

Referenced by GetCurrentValue(), IonCommand(), and IonLevelCommand().

fIonEnergyLevel

G4int G4ParticleGunMessenger::fIonEnergyLevel = 0

private

Definition at line 96 of file G4ParticleGunMessenger.hh.

Referenced by IonLevelCommand().

fIonExciteEnergy

G4double G4ParticleGunMessenger::fIonExciteEnergy = 0.0

private

Definition at line 94 of file G4ParticleGunMessenger.hh.

Referenced by IonCommand().

fIonFloatingLevelBase

char G4ParticleGunMessenger::fIonFloatingLevelBase = '\0'

private

Definition at line 95 of file G4ParticleGunMessenger.hh.

Referenced by IonCommand().

fParticleGun

G4ParticleGun* G4ParticleGunMessenger::fParticleGun = nullptr

private

Definition at line 69 of file G4ParticleGunMessenger.hh.

Referenced by G4ParticleGunMessenger(), GetCurrentValue(), IonCommand(), IonLevelCommand(), and SetNewValue().

fShootIon

G4bool G4ParticleGunMessenger::fShootIon = false

private

Definition at line 90 of file G4ParticleGunMessenger.hh.

Referenced by GetCurrentValue(), and SetNewValue().

gunDirectory

G4UIdirectory* G4ParticleGunMessenger::gunDirectory

private

Definition at line 74 of file G4ParticleGunMessenger.hh.

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

ionCmd

G4UIcommand* G4ParticleGunMessenger::ionCmd

private

Definition at line 85 of file G4ParticleGunMessenger.hh.

Referenced by G4ParticleGunMessenger(), GetCurrentValue(), IonCommand(), SetNewValue(), and ~G4ParticleGunMessenger().

ionLvlCmd

G4UIcommand* G4ParticleGunMessenger::ionLvlCmd

private

Definition at line 86 of file G4ParticleGunMessenger.hh.

Referenced by G4ParticleGunMessenger(), IonLevelCommand(), SetNewValue(), and ~G4ParticleGunMessenger().

listCmd

G4UIcmdWithoutParameter* G4ParticleGunMessenger::listCmd

private

Definition at line 75 of file G4ParticleGunMessenger.hh.

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

momAmpCmd

G4UIcmdWithADoubleAndUnit* G4ParticleGunMessenger::momAmpCmd

private

Definition at line 79 of file G4ParticleGunMessenger.hh.

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

momCmd

G4UIcmdWith3VectorAndUnit* G4ParticleGunMessenger::momCmd

private

Definition at line 80 of file G4ParticleGunMessenger.hh.

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

numberCmd

G4UIcmdWithAnInteger* G4ParticleGunMessenger::numberCmd

private

Definition at line 84 of file G4ParticleGunMessenger.hh.

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

particleCmd

G4UIcmdWithAString* G4ParticleGunMessenger::particleCmd

private

Definition at line 76 of file G4ParticleGunMessenger.hh.

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

particleTable

G4ParticleTable* G4ParticleGunMessenger::particleTable = nullptr

private

Definition at line 70 of file G4ParticleGunMessenger.hh.

Referenced by G4ParticleGunMessenger(), and SetNewValue().

polCmd

G4UIcmdWith3Vector* G4ParticleGunMessenger::polCmd

private

Definition at line 83 of file G4ParticleGunMessenger.hh.

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

positionCmd

G4UIcmdWith3VectorAndUnit* G4ParticleGunMessenger::positionCmd

private

Definition at line 81 of file G4ParticleGunMessenger.hh.

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

timeCmd

G4UIcmdWithADoubleAndUnit* G4ParticleGunMessenger::timeCmd

private

Definition at line 82 of file G4ParticleGunMessenger.hh.

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

---

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

• source/event/include/G4ParticleGunMessenger.hh
• source/event/src/G4ParticleGunMessenger.cc