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

#include <ClusterLayerConst.h>

Public Member Functions

 ConstClusterLayer ()
 default constructor More...
 
 ConstClusterLayer (eic::Index ID, eic::Index clusterID, std::int32_t layer, std::uint32_t nhits, float energy, float energyError, float radius, float skewness, eic::VectorXYZ position)
 
 ConstClusterLayer (ClusterLayerObj *obj)
 constructor from existing ClusterLayerObj More...
 
 ConstClusterLayer (const ConstClusterLayer &other)
 copy constructor More...
 
ConstClusterLayer & operator= (const ConstClusterLayer &other)
 copy-assignment operator More...
 
ConstClusterLayer clone () const
 support cloning (deep-copy) More...
 
 ~ConstClusterLayer ()
 destructor More...
 
const eic::Index & ID () const
 Access the unique layer ID. More...
 
const eic::Index & clusterID () const
 Access the associated full 3D cluster, -1 if none. More...
 
const std::int32_t & layer () const
 Access the layer number for this cluster layer. More...
 
const std::uint32_t & nhits () const
 Access the Number of hits. More...
 
const float & energy () const
 Access the Energy in this cluster layer [GeV]. More...
 
const float & energyError () const
 Access the Error on energy [GeV]. More...
 
const float & radius () const
 Access the Shower radius [mm]. More...
 
const float & skewness () const
 Access the Skewness of hits distribution. More...
 
const eic::VectorXYZ & position () const
 Access the Global center position. [mm]. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from ClusterLayerObj instance More...
 
bool operator== (const ConstClusterLayer &other) const
 
bool operator== (const ClusterLayer &other) const
 
bool operator< (const ConstClusterLayer &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class ClusterLayer
 
class ClusterLayerCollection
 
class ClusterLayerConstCollectionIterator
 

Detailed Description

2D Cluster in a single layer for a multi-layer detector

Author
: S. Joosten, C. Peng

Constructor & Destructor Documentation

◆ ConstClusterLayer() [1/4]

eic::ConstClusterLayer::ConstClusterLayer ( )

default constructor

◆ ConstClusterLayer() [2/4]

eic::ConstClusterLayer::ConstClusterLayer ( eic::Index  ID,
eic::Index  clusterID,
std::int32_t  layer,
std::uint32_t  nhits,
float  energy,
float  energyError,
float  radius,
float  skewness,
eic::VectorXYZ  position 
)

◆ ConstClusterLayer() [3/4]

eic::ConstClusterLayer::ConstClusterLayer ( ClusterLayerObj *  obj)

constructor from existing ClusterLayerObj

◆ ConstClusterLayer() [4/4]

eic::ConstClusterLayer::ConstClusterLayer ( const ConstClusterLayer &  other)

copy constructor

◆ ~ConstClusterLayer()

eic::ConstClusterLayer::~ConstClusterLayer ( )

destructor

Member Function Documentation

◆ clone()

ConstClusterLayer eic::ConstClusterLayer::clone ( ) const

support cloning (deep-copy)

◆ clusterID()

const eic::Index & eic::ConstClusterLayer::clusterID ( ) const

Access the associated full 3D cluster, -1 if none.

◆ energy()

const float & eic::ConstClusterLayer::energy ( ) const

Access the Energy in this cluster layer [GeV].

◆ energyError()

const float & eic::ConstClusterLayer::energyError ( ) const

Access the Error on energy [GeV].

◆ getObjectID()

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

◆ ID()

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

Access the unique layer ID.

◆ id()

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

◆ isAvailable()

bool eic::ConstClusterLayer::isAvailable ( ) const

check whether the object is actually available

◆ layer()

const std::int32_t & eic::ConstClusterLayer::layer ( ) const

Access the layer number for this cluster layer.

◆ nhits()

const std::uint32_t & eic::ConstClusterLayer::nhits ( ) const

Access the Number of hits.

◆ operator<()

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

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

bool eic::ConstClusterLayer::operator== ( const ClusterLayer &  other) const

◆ operator==() [2/2]

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

◆ position()

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

Access the Global center position. [mm].

◆ radius()

const float & eic::ConstClusterLayer::radius ( ) const

Access the Shower radius [mm].

◆ skewness()

const float & eic::ConstClusterLayer::skewness ( ) const

Access the Skewness of hits distribution.

◆ unlink()

void eic::ConstClusterLayer::unlink ( )
inline

disconnect from ClusterLayerObj instance

Friends And Related Function Documentation

◆ ClusterLayer

friend class ClusterLayer
friend

◆ ClusterLayerCollection

friend class ClusterLayerCollection
friend

◆ ClusterLayerConstCollectionIterator

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