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

#include <ProtoClusterConst.h>

Public Member Functions

 ConstProtoCluster ()
 default constructor More...
 
 ConstProtoCluster (eic::Index hitID, eic::Index clusterID, eic::Weight weight)
 
 ConstProtoCluster (ProtoClusterObj *obj)
 constructor from existing ProtoClusterObj More...
 
 ConstProtoCluster (const ConstProtoCluster &other)
 copy constructor More...
 
ConstProtoCluster & operator= (const ConstProtoCluster &other)
 copy-assignment operator More...
 
ConstProtoCluster clone () const
 support cloning (deep-copy) More...
 
 ~ConstProtoCluster ()
 destructor More...
 
const eic::Index & hitID () const
 Access the Hit ID. More...
 
const eic::Index & clusterID () const
 Access the ID of the cluster associated with this hit (-1 if none) More...
 
const eic::Weight & weight () const
 Access the How much of this hit belongs to the cluster? [0->1]. More...
 
bool isAvailable () const
 check whether the object is actually available More...
 
void unlink ()
 disconnect from ProtoClusterObj instance More...
 
bool operator== (const ConstProtoCluster &other) const
 
bool operator== (const ProtoCluster &other) const
 
bool operator< (const ConstProtoCluster &other) const
 
unsigned int id () const
 
const podio::ObjectID getObjectID () const
 

Friends

class ProtoCluster
 
class ProtoClusterCollection
 
class ProtoClusterConstCollectionIterator
 

Detailed Description

Relational info linking hits to their associated cluster

Author
: S. Joosten

Constructor & Destructor Documentation

◆ ConstProtoCluster() [1/4]

eic::ConstProtoCluster::ConstProtoCluster ( )

default constructor

◆ ConstProtoCluster() [2/4]

eic::ConstProtoCluster::ConstProtoCluster ( eic::Index  hitID,
eic::Index  clusterID,
eic::Weight  weight 
)

◆ ConstProtoCluster() [3/4]

eic::ConstProtoCluster::ConstProtoCluster ( ProtoClusterObj *  obj)

constructor from existing ProtoClusterObj

◆ ConstProtoCluster() [4/4]

eic::ConstProtoCluster::ConstProtoCluster ( const ConstProtoCluster &  other)

copy constructor

◆ ~ConstProtoCluster()

eic::ConstProtoCluster::~ConstProtoCluster ( )

destructor

Member Function Documentation

◆ clone()

ConstProtoCluster eic::ConstProtoCluster::clone ( ) const

support cloning (deep-copy)

◆ clusterID()

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

Access the ID of the cluster associated with this hit (-1 if none)

◆ getObjectID()

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

◆ hitID()

const eic::Index & eic::ConstProtoCluster::hitID ( ) const

Access the Hit ID.

◆ id()

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

◆ isAvailable()

bool eic::ConstProtoCluster::isAvailable ( ) const

check whether the object is actually available

◆ operator<()

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

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

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

◆ operator==() [2/2]

bool eic::ConstProtoCluster::operator== ( const ProtoCluster &  other) const

◆ unlink()

void eic::ConstProtoCluster::unlink ( )
inline

disconnect from ProtoClusterObj instance

◆ weight()

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

Access the How much of this hit belongs to the cluster? [0->1].

Friends And Related Function Documentation

◆ ProtoCluster

friend class ProtoCluster
friend

◆ ProtoClusterCollection

friend class ProtoClusterCollection
friend

◆ ProtoClusterConstCollectionIterator

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