BDSIonDefinition Class Reference

Class to parse an ion particle definition. More...

#include <BDSIonDefinition.hh>

Collaboration diagram for BDSIonDefinition:

Public Member Functions
	BDSIonDefinition (const G4String &definition)
	BDSIonDefinition (G4int aIn, G4int zIn, G4double qIn)
G4int	A () const
	Accessor. More...
G4int	Z () const
	Accessor. More...
G4double	Charge () const
	Accessor. More...
G4double	ExcitationEnergy () const
	Accessor. More...
G4bool	OverrideCharge () const
	Accessor. More...
G4int	NElectrons () const
	Accessor. More...

Private Member Functions
	BDSIonDefinition ()=delete
	No default constructor.
void	Parse (const G4String &definition)
	Parse the definition. More...

Private Attributes
G4int	a
G4int	z
G4double	charge
	In units of eplus. More...
G4double	energy
	Excitation energy. G4units. More...
G4bool	overrideCharge
	Whether to specify the charge. More...
G4int	nElectrons
	Inferred number of bound electrons if any. More...

Friends
std::ostream &	operator<< (std::ostream &out, BDSIonDefinition const &io)
	Output streamer. More...

Detailed Description

Class to parse an ion particle definition.

Author

Laurie Nevay

Definition at line 32 of file BDSIonDefinition.hh.

Constructor & Destructor Documentation

BDSIonDefinition() [1/2]

BDSIonDefinition::BDSIonDefinition ( const G4String &  definition )

explicit

Definition at line 32 of file BDSIonDefinition.cc.

BDSIonDefinition() [2/2]

BDSIonDefinition::BDSIonDefinition	(	G4int	aIn,
		G4int	zIn,
		G4double	qIn
	)

Definition at line 51 of file BDSIonDefinition.cc.

~BDSIonDefinition()

BDSIonDefinition::~BDSIonDefinition ( )

inline

Definition at line 39 of file BDSIonDefinition.hh.

Member Function Documentation

A()

G4int BDSIonDefinition::A ( ) const

inline

Accessor.

Definition at line 42 of file BDSIonDefinition.hh.

Referenced by BDSOutput::FillEventPrimaryOnly(), BDSBunchUserFile< T >::GetNextParticleLocal(), BDSBunchSixTrackLink::UpdateGeant4ParticleDefinition(), BDSBunch::UpdateIonDefinition(), and BDSBunchSixTrackLink::UpdateIonDefinition().

Here is the caller graph for this function:

Charge()

G4double BDSIonDefinition::Charge ( ) const

inline

Accessor.

Definition at line 44 of file BDSIonDefinition.hh.

References charge.

Referenced by BDSParticleDefinition::BDSParticleDefinition().

Here is the caller graph for this function:

ExcitationEnergy()

G4double BDSIonDefinition::ExcitationEnergy ( ) const

inline

Accessor.

Definition at line 45 of file BDSIonDefinition.hh.

References energy.

Referenced by BDSBunchUserFile< T >::GetNextParticleLocal(), BDSBunchSixTrackLink::UpdateGeant4ParticleDefinition(), BDSBunch::UpdateIonDefinition(), and BDSBunchSixTrackLink::UpdateIonDefinition().

Here is the caller graph for this function:

NElectrons()

G4int BDSIonDefinition::NElectrons ( ) const

inline

Accessor.

Definition at line 47 of file BDSIonDefinition.hh.

References nElectrons.

Referenced by BDSParticleDefinition::NElectrons().

Here is the caller graph for this function:

OverrideCharge()

G4bool BDSIonDefinition::OverrideCharge ( ) const

inline

Accessor.

Definition at line 46 of file BDSIonDefinition.hh.

References overrideCharge.

Referenced by BDSParticleDefinition::BDSParticleDefinition().

Here is the caller graph for this function:

Parse()

void BDSIonDefinition::Parse ( const G4String &  definition )

private

Parse the definition.

Definition at line 87 of file BDSIonDefinition.cc.

References charge, energy, nElectrons, and overrideCharge.

Z()

G4int BDSIonDefinition::Z ( ) const

inline

Accessor.

Definition at line 43 of file BDSIonDefinition.hh.

Referenced by BDSOutput::FillEventPrimaryOnly(), BDSBunchUserFile< T >::GetNextParticleLocal(), BDSBunchSixTrackLink::UpdateGeant4ParticleDefinition(), BDSBunch::UpdateIonDefinition(), and BDSBunchSixTrackLink::UpdateIonDefinition().

Here is the caller graph for this function:

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  out, BDSIonDefinition const &  io  )

friend

Output streamer.

Definition at line 80 of file BDSIonDefinition.cc.

Field Documentation

a

G4int BDSIonDefinition::a

private

Definition at line 60 of file BDSIonDefinition.hh.

charge

G4double BDSIonDefinition::charge

private

In units of eplus.

Definition at line 62 of file BDSIonDefinition.hh.

Referenced by Charge(), BDSParticleDefinition::operator=(), and Parse().

energy

G4double BDSIonDefinition::energy

private

Excitation energy. G4units.

Definition at line 63 of file BDSIonDefinition.hh.

Referenced by ExcitationEnergy(), and Parse().

nElectrons

G4int BDSIonDefinition::nElectrons

private

Inferred number of bound electrons if any.

Definition at line 65 of file BDSIonDefinition.hh.

Referenced by NElectrons(), and Parse().

overrideCharge

G4bool BDSIonDefinition::overrideCharge

private

Whether to specify the charge.

Definition at line 64 of file BDSIonDefinition.hh.

Referenced by OverrideCharge(), and Parse().

z

G4int BDSIonDefinition::z

private

Definition at line 61 of file BDSIonDefinition.hh.

---

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

• /Users/nevay/physics/reps/bdsim/include/BDSIonDefinition.hh
• /Users/nevay/physics/reps/bdsim/src/BDSIonDefinition.cc