EICd
EIC data model
Public Member Functions | Friends | List of all members
eic::ConstBasicParticle Class Reference

#include <BasicParticleConst.h>

Public Member Functions

 ConstBasicParticle ()
 default constructor More...
 
 ConstBasicParticle (eic::Index ID, eic::VectorXYZ p, eic::VectorXYZ v, float time, std::int32_t pid, std::int16_t status, std::int16_t charge, eic::Weight weight)
 
 ConstBasicParticle (BasicParticleObj *obj)
 constructor from existing BasicParticleObj More...
 
 ConstBasicParticle (const ConstBasicParticle &other)
 copy constructor More...
 
ConstBasicParticle & operator= (const ConstBasicParticle &other)
 copy-assignment operator More...
 
ConstBasicParticle clone () const
 support cloning (deep-copy) More...
 
 ~ConstBasicParticle ()
 destructor More...
 
const eic::Index & ID () const
 Access the Unique particle index. More...
 
const eic::VectorXYZ & p () const
 Access the momentum [GeV]. More...
 
const eic::VectorXYZ & v () const
 Access the vertex [mm]. More...
 
const float & time () const
 Access the Time in [ns]. More...
 
const std::int32_t & pid () const
 Access the particle PDG code. More...
 
const std::int16_t & status () const
 Access the Status code. More...
 
const std::int16_t & charge () const
 Access the Particle charge (or sign) More...
 
const eic::Weight & weight () const
 Access the Particle weight, e.g. from PID algorithm [0-1]. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from BasicParticleObj instance More...
 
bool operator== (const ConstBasicParticle &other) const
 
bool operator== (const BasicParticle &other) const
 
bool operator< (const ConstBasicParticle &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class BasicParticle
 
class BasicParticleCollection
 
class BasicParticleConstCollectionIterator
 

Detailed Description

Basic particle used internally to communicate basic particle properties.

Author
: W. Armstrong, S. Joosten

Constructor & Destructor Documentation

◆ ConstBasicParticle() [1/4]

eic::ConstBasicParticle::ConstBasicParticle ( )

default constructor

◆ ConstBasicParticle() [2/4]

eic::ConstBasicParticle::ConstBasicParticle ( eic::Index  ID,
eic::VectorXYZ  p,
eic::VectorXYZ  v,
float  time,
std::int32_t  pid,
std::int16_t  status,
std::int16_t  charge,
eic::Weight  weight 
)

◆ ConstBasicParticle() [3/4]

eic::ConstBasicParticle::ConstBasicParticle ( BasicParticleObj *  obj)

constructor from existing BasicParticleObj

◆ ConstBasicParticle() [4/4]

eic::ConstBasicParticle::ConstBasicParticle ( const ConstBasicParticle &  other)

copy constructor

◆ ~ConstBasicParticle()

eic::ConstBasicParticle::~ConstBasicParticle ( )

destructor

Member Function Documentation

◆ charge()

const std::int16_t & eic::ConstBasicParticle::charge ( ) const

Access the Particle charge (or sign)

◆ clone()

ConstBasicParticle eic::ConstBasicParticle::clone ( ) const

support cloning (deep-copy)

◆ getObjectID()

const podio::ObjectID eic::ConstBasicParticle::getObjectID ( ) const

◆ ID()

const eic::Index & eic::ConstBasicParticle::ID ( ) const

Access the Unique particle index.

◆ id()

unsigned int eic::ConstBasicParticle::id ( ) const
inline

◆ isAvailable()

bool eic::ConstBasicParticle::isAvailable ( ) const

check whether the object is actually available

◆ operator<()

bool eic::ConstBasicParticle::operator< ( const ConstBasicParticle &  other) const
inline

◆ operator=()

ConstBasicParticle & eic::ConstBasicParticle::operator= ( const ConstBasicParticle &  other)

copy-assignment operator

◆ operator==() [1/2]

bool eic::ConstBasicParticle::operator== ( const BasicParticle &  other) const

◆ operator==() [2/2]

bool eic::ConstBasicParticle::operator== ( const ConstBasicParticle &  other) const
inline

◆ p()

const eic::VectorXYZ & eic::ConstBasicParticle::p ( ) const

Access the momentum [GeV].

◆ pid()

const std::int32_t & eic::ConstBasicParticle::pid ( ) const

Access the particle PDG code.

◆ status()

const std::int16_t & eic::ConstBasicParticle::status ( ) const

Access the Status code.

◆ time()

const float & eic::ConstBasicParticle::time ( ) const

Access the Time in [ns].

◆ unlink()

void eic::ConstBasicParticle::unlink ( )
inline

disconnect from BasicParticleObj instance

◆ v()

const eic::VectorXYZ & eic::ConstBasicParticle::v ( ) const

Access the vertex [mm].

◆ weight()

const eic::Weight & eic::ConstBasicParticle::weight ( ) const

Access the Particle weight, e.g. from PID algorithm [0-1].

Friends And Related Function Documentation

◆ BasicParticle

friend class BasicParticle
friend

◆ BasicParticleCollection

friend class BasicParticleCollection
friend

◆ BasicParticleConstCollectionIterator

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