TruthParticleBase Class Reference

#include <TruthParticleBase.h>

Collaboration diagram for TruthParticleBase:

Public Member Functions
	TruthParticleBase ()
	Default constructor:
	TruthParticleBase (const TruthParticleBase &rhs)
	Copy constructor:
TruthParticleBase &	operator= (const TruthParticleBase &rhs)
	Assignment operator:
	TruthParticleBase (const HepMC::GenParticlePtr mc)
	Constructor with parameters:
	~TruthParticleBase ()
	Destructor:
HepMC::ConstGenParticlePtr	genParticle () const
	return the HepMC::GenParticle which is being proxied
const AthenaBarCodeImpl &	getAthenaBarCodeImpl () const
	return the (atlas) unique identifier
void	setCharge (const ChargeType charge)
	Set the charge of this TruthParticleBase.
void	setGenParticle (HepMC::ConstGenParticlePtr particle)
	Fill the data members of ParticleBase from the GenParticle.
AthenaBarCodeImpl &	getAthenaBarCodeImpl ()
	return the (atlas) unique identifier
void	set_dataType (ParticleDataType::DataType)
void	set_charge (ChargeType x)
void	set_pdgId (int)
void	set_origin (const VxContainer *, int)
void	set_origin (const VxContainer *, const Trk::VxCandidate *)
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 eparticle id.
std::ostream &	dump (std::ostream &out) const
	Print IParticle content.

Private Attributes
ChargeType	m_charge
	The charge of this TruthParticle.
HepMC::ConstGenParticlePtr	m_genParticle
	The HepMC::GenParticle we are proxying.
AthenaBarCodeImpl	m_abc
	The AthenaBarCodeImpl held to provide unique identification throughout the whole Atlas EDM.

Detailed Description

Definition at line 33 of file TruthParticleBase.h.

Constructor & Destructor Documentation

TruthParticleBase() [1/3]

TruthParticleBase::TruthParticleBase

(

)

Default constructor:

Definition at line 28 of file TruthParticleBase.cxx.

                                     :
  m_charge     ( -999. ),
  m_genParticle(    0  ),
  m_abc        ()
{}

TruthParticleBase() [2/3]

TruthParticleBase::TruthParticleBase

(

const TruthParticleBase &

rhs

)

Copy constructor:

Definition at line 34 of file TruthParticleBase.cxx.

                                                                   :
  m_charge     ( rhs.m_charge ),
  m_genParticle( rhs.m_genParticle ),
  m_abc        ( rhs.m_abc)
{}

TruthParticleBase() [3/3]

TruthParticleBase::TruthParticleBase

(

const HepMC::GenParticlePtr

mc

)

Constructor with parameters:

Definition at line 51 of file TruthParticleBase.cxx.

                                                                   :
  m_charge     ( -999. ),
  m_genParticle(   mc  ),
  m_abc        ()
{}

~TruthParticleBase()

TruthParticleBase::~TruthParticleBase

(

)

Destructor:

Definition at line 61 of file TruthParticleBase.cxx.

{}

Member Function Documentation

charge()

ChargeType TruthParticleBase::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 162 of file TruthParticleBase.h.

{
  return m_charge;
}

dataType()

ParticleDataType::DataType TruthParticleBase::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 150 of file TruthParticleBase.h.

{
  return ParticleDataType::True;
}

dump()

std::ostream & TruthParticleBase::dump

(

std::ostream &

out

)

const

Print IParticle content.

Definition at line 83 of file TruthParticleBase.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  ] =  --Null ptr-- ";
 
  out << buf.str();
 
  //Dump the AthenaBarCode Part
  m_abc.dump(out);
 
  return out;
}

genParticle()

HepMC::ConstGenParticlePtr TruthParticleBase::genParticle ( ) const

inline

return the HepMC::GenParticle which is being proxied

Definition at line 180 of file TruthParticleBase.h.

{
  return m_genParticle;
}

getAthenaBarCodeImpl() [1/2]

AthenaBarCodeImpl & TruthParticleBase::getAthenaBarCodeImpl ( )

inline

return the (atlas) unique identifier

Definition at line 116 of file TruthParticleBase.h.

{return m_abc;}

getAthenaBarCodeImpl() [2/2]

const AthenaBarCodeImpl & TruthParticleBase::getAthenaBarCodeImpl ( ) const

inline

return the (atlas) unique identifier

Definition at line 103 of file TruthParticleBase.h.

{return m_abc;}

hasCharge()

bool TruthParticleBase::hasCharge ( ) const

inline

method to check if charge information is available

Definition at line 156 of file TruthParticleBase.h.

{
  return true;
}

hasPdgId()

bool TruthParticleBase::hasPdgId ( ) const

inline

method to check if particle id information is available

Definition at line 168 of file TruthParticleBase.h.

{
  return true;
}

operator=()

TruthParticleBase & TruthParticleBase::operator=

(

const TruthParticleBase &

rhs

)

Assignment operator:

Definition at line 41 of file TruthParticleBase.cxx.

{
  if ( this != &rhs ) {
    m_charge      = rhs.m_charge;
    m_genParticle = rhs.m_genParticle;
    m_abc         = rhs.m_abc;
  }
  return *this;
}

origin()

const Trk::RecVertex * TruthParticleBase::origin

(

)

const

Return a RecVertex corresponding to particle Origin.

Definition at line 69 of file TruthParticleBase.cxx.

{
  return 0;
}

originLink()

const ElementLink< VxContainer > & TruthParticleBase::originLink

(

)

const

Return the ElementLink to particle Origin.

Definition at line 76 of file TruthParticleBase.cxx.

{
  static const ElementLink<VxContainer> origin;
  return origin;
}

pdgId()

int TruthParticleBase::pdgId ( ) const

inline

Return eparticle id.

Definition at line 174 of file TruthParticleBase.h.

{
  return m_genParticle->pdg_id();
}

set_charge()

void TruthParticleBase::set_charge ( ChargeType x )

inline

Definition at line 120 of file TruthParticleBase.h.

{setCharge(x);}

set_dataType()

void TruthParticleBase::set_dataType ( ParticleDataType::DataType )

inline

Definition at line 119 of file TruthParticleBase.h.

{std::abort();}

set_origin() [1/2]

void TruthParticleBase::set_origin ( const VxContainer * , const Trk::VxCandidate *  )

inline

Definition at line 124 of file TruthParticleBase.h.

  {std::abort();}

set_origin() [2/2]

void TruthParticleBase::set_origin ( const VxContainer * , int  )

inline

Definition at line 122 of file TruthParticleBase.h.

  {std::abort();}

set_pdgId()

void TruthParticleBase::set_pdgId ( int )

inline

Definition at line 121 of file TruthParticleBase.h.

{std::abort();}

setCharge()

void TruthParticleBase::setCharge ( const ChargeType charge )

inline

Set the charge of this TruthParticleBase.

Definition at line 186 of file TruthParticleBase.h.

{
  m_charge = charge;
}

setGenParticle()

void TruthParticleBase::setGenParticle ( HepMC::ConstGenParticlePtr particle )

inline

Fill the data members of ParticleBase from the GenParticle.

Definition at line 192 of file TruthParticleBase.h.

{
  m_genParticle = std::move(mc);
}

Member Data Documentation

m_abc

AthenaBarCodeImpl TruthParticleBase::m_abc

private

The AthenaBarCodeImpl held to provide unique identification throughout the whole Atlas EDM.

Definition at line 141 of file TruthParticleBase.h.

m_charge

ChargeType TruthParticleBase::m_charge

private

The charge of this TruthParticle.

Definition at line 134 of file TruthParticleBase.h.

m_genParticle

HepMC::ConstGenParticlePtr TruthParticleBase::m_genParticle

private

The HepMC::GenParticle we are proxying.

Definition at line 137 of file TruthParticleBase.h.

---

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

• TruthParticleBase.h
• TruthParticleBase.cxx