EICd
EIC data model
eic::Vertex Class Reference

#include <Vertex.h>

Public Member Functions

 Vertex ()
 default constructor More...
 
 Vertex (eic::Index ID, eic::VectorXYZ position, float time, float chi2, float probability, bool primary)
 
 Vertex (VertexObj *obj)
 constructor from existing VertexObj More...
 
 Vertex (const Vertex &other)
 copy constructor More...
 
Vertexoperator= (const Vertex &other)
 copy-assignment operator More...
 
Vertex clone () const
 support cloning (deep-copy) More...
 
 ~Vertex ()
 destructor More...
 
 operator ConstVertex () const
 conversion to const object More...
 
const eic::IndexID () const
 Access the unique vertex ID. More...
 
const eic::VectorXYZposition () const
 Access the postion of vertex [mm]. More...
 
const float & time () const
 Access the time of vertex [ns]. More...
 
const float & chi2 () const
 Access the Chi squared of the vertex fit. More...
 
const float & probability () const
 Access the Probability of the vertex fit. More...
 
const bool & primary () const
 Access the Whether it is the primary vertex of the event. More...
 
void ID (eic::Index value)
 Set the unique vertex ID. More...
 
eic::IndexID ()
 Get reference to unique vertex ID. More...
 
void position (eic::VectorXYZ value)
 Set the postion of vertex [mm]. More...
 
eic::VectorXYZposition ()
 Get reference to postion of vertex [mm]. More...
 
void time (float value)
 Set the time of vertex [ns]. More...
 
void chi2 (float value)
 Set the Chi squared of the vertex fit. More...
 
void probability (float value)
 Set the Probability of the vertex fit. More...
 
void primary (bool value)
 Set the Whether it is the primary vertex of the event. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from VertexObj instance More...
 
bool operator== (const Vertex &other) const
 
bool operator== (const ConstVertex &other) const
 
bool operator< (const Vertex &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class VertexCollection
 
class VertexCollectionIterator
 
class ConstVertex
 

Detailed Description

EIC vertex

Author
: W. Armstrong, S. Joosten

Constructor & Destructor Documentation

◆ Vertex() [1/4]

eic::Vertex::Vertex ( )

default constructor

◆ Vertex() [2/4]

eic::Vertex::Vertex ( eic::Index  ID,
eic::VectorXYZ  position,
float  time,
float  chi2,
float  probability,
bool  primary 
)

◆ Vertex() [3/4]

eic::Vertex::Vertex ( VertexObj obj)

constructor from existing VertexObj

◆ Vertex() [4/4]

eic::Vertex::Vertex ( const Vertex other)

copy constructor

◆ ~Vertex()

eic::Vertex::~Vertex ( )

destructor

Member Function Documentation

◆ chi2() [1/2]

const float & eic::Vertex::chi2 ( ) const

Access the Chi squared of the vertex fit.

◆ chi2() [2/2]

void eic::Vertex::chi2 ( float  value)

Set the Chi squared of the vertex fit.

◆ clone()

Vertex eic::Vertex::clone ( ) const

support cloning (deep-copy)

◆ getObjectID()

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

◆ ID() [1/3]

eic::Index & eic::Vertex::ID ( )

Get reference to unique vertex ID.

◆ ID() [2/3]

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

Access the unique vertex ID.

◆ id()

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

◆ ID() [3/3]

void eic::Vertex::ID ( eic::Index  value)

Set the unique vertex ID.

◆ isAvailable()

bool eic::Vertex::isAvailable ( ) const

check whether the object is actually available

◆ operator ConstVertex()

eic::Vertex::operator ConstVertex ( ) const

conversion to const object

◆ operator<()

bool eic::Vertex::operator< ( const Vertex other) const
inline

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

bool eic::Vertex::operator== ( const ConstVertex other) const

◆ operator==() [2/2]

bool eic::Vertex::operator== ( const Vertex other) const
inline

◆ position() [1/3]

eic::VectorXYZ & eic::Vertex::position ( )

Get reference to postion of vertex [mm].

◆ position() [2/3]

const eic::VectorXYZ & eic::Vertex::position ( ) const

Access the postion of vertex [mm].

◆ position() [3/3]

void eic::Vertex::position ( eic::VectorXYZ  value)

Set the postion of vertex [mm].

◆ primary() [1/2]

const bool & eic::Vertex::primary ( ) const

Access the Whether it is the primary vertex of the event.

◆ primary() [2/2]

void eic::Vertex::primary ( bool  value)

Set the Whether it is the primary vertex of the event.

◆ probability() [1/2]

const float & eic::Vertex::probability ( ) const

Access the Probability of the vertex fit.

◆ probability() [2/2]

void eic::Vertex::probability ( float  value)

Set the Probability of the vertex fit.

◆ time() [1/2]

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

Access the time of vertex [ns].

◆ time() [2/2]

void eic::Vertex::time ( float  value)

Set the time of vertex [ns].

◆ unlink()

void eic::Vertex::unlink ( )
inline

disconnect from VertexObj instance

Friends And Related Function Documentation

◆ ConstVertex

friend class ConstVertex
friend

◆ VertexCollection

friend class VertexCollection
friend

◆ VertexCollectionIterator

friend class VertexCollectionIterator
friend

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