ParticleEvent::Base Class Reference

#include <Base.h>

Collaboration diagram for ParticleEvent::Base:

Public Member Functions
	Base ()
	Default constructor:
	Base (const Base &rhs)
	Copy constructor:
Base &	operator= (const Base &rhs)
	Assignment operator:
virtual	~Base ()
	Constructor with parameters:
void	set_dataType (ParticleDataType::DataType x)
void	set_charge (ChargeType x)
void	set_pdgId (int x)
void	reset_charge ()
void	reset_pdgId ()
void	set_origin (const VxContainer *theContainer, int index)
void	set_origin (const VxContainer *theContainer, const Trk::VxCandidate *vertex)
void	set_origin (const ElementLink< VxContainer > &origin)
AthenaBarCodeImpl &	getAthenaBarCodeImpl ()
ParticleDataType::DataType	dataType () const
	Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4}.
const Trk::RecVertex *	origin () const
	Return a RecVertex corresponding to particle Origin.
const ElementLink< VxContainer > &	originLink () const
	Return the ElementLink to particle Origin.
bool	hasCharge () const
	method to check if charge information is available
ChargeType	charge () const
	returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface
bool	hasPdgId () const
	method to check if particle id information is available
int	pdgId () const
	Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h.
std::ostream &	dump (std::ostream &out) const
	Print IParticle content.
const AthenaBarCodeImpl &	getAthenaBarCodeImpl () const

Private Attributes
ParticleDataType::DataType	m_dataType
	the enum storing the (data) type of this particle
ElementLink< VxContainer >	m_origin
	Persistent pointer to the origin of this particle.
bool	m_hasCharge
	Switch to tell if this particle has a charge.
ChargeType	m_charge
	Value of the charge of the particle (this has real meaning, only if hasCharge() returns true)
bool	m_hasPdgId
	Switch to tell if this particle has a PDG Identity.
int	m_pdgId
	Value for the PDG identity (this has real meaning, only if hasPdgId() returns true)
AthenaBarCodeImpl	m_abc
	The AthenaBarCode Part.

Detailed Description

Definition at line 33 of file Base.h.

Constructor & Destructor Documentation

Base() [1/2]

Base::Base ( )

inline

Default constructor:

Definition at line 163 of file Base.h.

           :
  m_dataType ( ),
  m_origin   ( ),
  m_hasCharge( false ),
  m_charge   ( 0. ),
  m_hasPdgId ( false ),
  m_pdgId    ( 0 ),
  m_abc      ()
{}

Base() [2/2]

Base::Base ( const Base & rhs )

inlineexplicit

Copy constructor:

Definition at line 174 of file Base.h.

                            :
  m_dataType ( rhs.m_dataType  ),
  m_origin   ( rhs.m_origin    ),
  m_hasCharge( rhs.m_hasCharge ),
  m_charge   ( rhs.m_charge    ),
  m_hasPdgId ( rhs.m_hasPdgId  ),
  m_pdgId    ( rhs.m_pdgId     ),
  m_abc      ( rhs.m_abc)
{}

~Base()

Base::~Base ( )

inlinevirtual

Constructor with parameters:

Destructor:

Definition at line 200 of file Base.h.

{}

Member Function Documentation

charge()

ChargeType Base::charge ( ) const

inline

returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface

Definition at line 224 of file Base.h.

{ 
  return m_charge;
}

dataType()

ParticleDataType::DataType Base::dataType ( ) const

inline

Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4}.

IParticle interface-like declaration

Definition at line 204 of file Base.h.

{
  return m_dataType;
}

dump()

std::ostream & Base::dump

(

std::ostream &

out

)

const

Print IParticle content.

Definition at line 44 of file Base.cxx.

{
  std::stringstream buf;
  buf << "[dataType] = " << this->dataType() << "\n"
 
      << "[charge  ] = " 
      << std::setw(5) << std::boolalpha << this->hasCharge()
      << std::scientific << std::right << std::setw(16) << std::setprecision(8)
      << this->charge()  << "\n"
 
      << "[pdg-Id  ] = " << std::setw(5) << std::boolalpha << this->hasPdgId()
      << std::fixed << std::right << std::setw(16) << std::setprecision(8)
      << this->pdgId()   << "\n"
 
      << "[origin  ] = ";
  if ( this->origin() ) { this->origin()->dump( buf );
  } else {                buf << " --Null ptr-- ";
  }
 
  this->getAthenaBarCodeImpl().dump(buf);
 
  return out << buf.str();
}

getAthenaBarCodeImpl() [1/2]

AthenaBarCodeImpl & ParticleEvent::Base::getAthenaBarCodeImpl ( )

inline

Definition at line 115 of file Base.h.

{return m_abc;}

getAthenaBarCodeImpl() [2/2]

const AthenaBarCodeImpl & ParticleEvent::Base::getAthenaBarCodeImpl ( ) const

inline

Definition at line 96 of file Base.h.

{return m_abc;}

hasCharge()

bool Base::hasCharge ( ) const

inline

method to check if charge information is available

Definition at line 218 of file Base.h.

{ 
  return m_hasCharge;
}

hasPdgId()

bool Base::hasPdgId ( ) const

inline

method to check if particle id information is available

Definition at line 230 of file Base.h.

{
  return m_hasPdgId;
}

operator=()

Base & Base::operator= ( const Base & rhs )

inline

Assignment operator:

Definition at line 185 of file Base.h.

{
  if ( this != &rhs ) {
    m_dataType  = rhs.m_dataType;
    m_origin    = rhs.m_origin;
    m_hasCharge = rhs.m_hasCharge;
    m_charge    = rhs.m_charge;
    m_hasPdgId  = rhs.m_hasPdgId;
    m_pdgId     = rhs.m_pdgId;
    m_abc       = rhs.m_abc;
  }
  return *this;
}

origin()

const Trk::RecVertex * Base::origin ( ) const

inline

Return a RecVertex corresponding to particle Origin.

Definition at line 210 of file Base.h.

{
  return (!m_origin.isValid()) 
    ? 0 
    : &(**m_origin).recVertex();
}

originLink()

const ElementLink< VxContainer > & Base::originLink

(

)

const

Return the ElementLink to particle Origin.

Definition at line 38 of file Base.cxx.

{
  return m_origin;
}

pdgId()

int Base::pdgId ( ) const

inline

Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h.

Definition at line 236 of file Base.h.

{
  return m_pdgId;
}

reset_charge()

void Base::reset_charge ( )

inline

Definition at line 270 of file Base.h.

{ 
  m_hasCharge = false;
}

reset_pdgId()

void Base::reset_pdgId ( )

inline

Definition at line 277 of file Base.h.

{ 
  m_hasPdgId = false;
}

set_charge()

void Base::set_charge ( ChargeType x )

inline

Definition at line 254 of file Base.h.

{ 
  m_charge = x; 
  m_hasCharge = true;
}

set_dataType()

void Base::set_dataType ( ParticleDataType::DataType x )

inline

Definition at line 247 of file Base.h.

{ 
  m_dataType = x;
}

set_origin() [1/3]

void Base::set_origin ( const ElementLink< VxContainer > & origin )

inline

Definition at line 300 of file Base.h.

{
  m_origin = origin;
}

set_origin() [2/3]

void Base::set_origin ( const VxContainer * theContainer, const Trk::VxCandidate * vertex )

inline

Definition at line 291 of file Base.h.

{
  m_origin = ElementLink< VxContainer >
    ((vertex),*theContainer );
}

set_origin() [3/3]

void Base::set_origin ( const VxContainer * theContainer, int index )

inline

Definition at line 284 of file Base.h.

{
  m_origin = ElementLink< VxContainer >(*theContainer, index);
}

set_pdgId()

void Base::set_pdgId ( int x )

inline

Definition at line 262 of file Base.h.

{ 
  m_pdgId = x; 
  m_hasPdgId = true;
}

Member Data Documentation

m_abc

AthenaBarCodeImpl ParticleEvent::Base::m_abc

private

The AthenaBarCode Part.

Definition at line 148 of file Base.h.

m_charge

ChargeType ParticleEvent::Base::m_charge

private

Value of the charge of the particle (this has real meaning, only if hasCharge() returns true)

Definition at line 136 of file Base.h.

m_dataType

ParticleDataType::DataType ParticleEvent::Base::m_dataType

private

the enum storing the (data) type of this particle

Definition at line 123 of file Base.h.

m_hasCharge

bool ParticleEvent::Base::m_hasCharge

private

Switch to tell if this particle has a charge.

Definition at line 131 of file Base.h.

m_hasPdgId

bool ParticleEvent::Base::m_hasPdgId

private

Switch to tell if this particle has a PDG Identity.

Definition at line 140 of file Base.h.

m_origin

ElementLink< VxContainer > ParticleEvent::Base::m_origin

private

Persistent pointer to the origin of this particle.

Definition at line 127 of file Base.h.

m_pdgId

int ParticleEvent::Base::m_pdgId

private

Value for the PDG identity (this has real meaning, only if hasPdgId() returns true)

Definition at line 145 of file Base.h.

---

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

• Base.h
• Base.cxx