eic::ProtoCluster Class Reference

#include <ProtoCluster.h>

Public Member Functions
	ProtoCluster ()
	default constructor More...
	ProtoCluster (eic::Index hitID, eic::Index clusterID, eic::Weight weight)
	ProtoCluster (ProtoClusterObj *obj)
	constructor from existing ProtoClusterObj More...
	ProtoCluster (const ProtoCluster &other)
	copy constructor More...
ProtoCluster &	operator= (const ProtoCluster &other)
	copy-assignment operator More...
ProtoCluster	clone () const
	support cloning (deep-copy) More...
	~ProtoCluster ()
	destructor More...
	operator ConstProtoCluster () const
	conversion to const object 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...
void	hitID (eic::Index value)
	Set the Hit ID. More...
eic::Index &	hitID ()
	Get reference to Hit ID. More...
void	clusterID (eic::Index value)
	Set the ID of the cluster associated with this hit (-1 if none) More...
eic::Index &	clusterID ()
	Get reference to ID of the cluster associated with this hit (-1 if none) More...
void	weight (eic::Weight value)
	Set the How much of this hit belongs to the cluster? [0->1]. More...
eic::Weight &	weight ()
	Get reference to 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 ProtoCluster &other) const
bool	operator== (const ConstProtoCluster &other) const
bool	operator< (const ProtoCluster &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	ProtoClusterCollection
class	ProtoClusterCollectionIterator
class	ConstProtoCluster

Detailed Description

Relational info linking hits to their associated cluster

Author

: S. Joosten

Constructor & Destructor Documentation

ProtoCluster() [1/4]

eic::ProtoCluster::ProtoCluster

(

)

default constructor

ProtoCluster() [2/4]

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

ProtoCluster() [3/4]

eic::ProtoCluster::ProtoCluster

(

ProtoClusterObj *

obj

)

constructor from existing ProtoClusterObj

ProtoCluster() [4/4]

eic::ProtoCluster::ProtoCluster

(

const ProtoCluster &

other

)

copy constructor

~ProtoCluster()

eic::ProtoCluster::~ProtoCluster

(

)

destructor

Member Function Documentation

clone()

ProtoCluster eic::ProtoCluster::clone

(

)

const

support cloning (deep-copy)

clusterID() [1/3]

eic::Index & eic::ProtoCluster::clusterID

(

)

Get reference to ID of the cluster associated with this hit (-1 if none)

clusterID() [2/3]

const eic::Index & eic::ProtoCluster::clusterID

(

)

const

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

clusterID() [3/3]

void eic::ProtoCluster::clusterID

(

eic::Index

value

)

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

getObjectID()

const podio::ObjectID eic::ProtoCluster::getObjectID

(

)

const

hitID() [1/3]

eic::Index & eic::ProtoCluster::hitID

(

)

Get reference to Hit ID.

hitID() [2/3]

const eic::Index & eic::ProtoCluster::hitID

(

)

const

Access the Hit ID.

hitID() [3/3]

void eic::ProtoCluster::hitID

(

eic::Index

value

)

Set the Hit ID.

id()

unsigned int eic::ProtoCluster::id ( ) const

inline

isAvailable()

bool eic::ProtoCluster::isAvailable

(

)

const

check whether the object is actually available

operator ConstProtoCluster()

eic::ProtoCluster::operator ConstProtoCluster

(

)

const

conversion to const object

operator<()

bool eic::ProtoCluster::operator< ( const ProtoCluster &  other ) const

inline

operator=()

ProtoCluster & eic::ProtoCluster::operator=

(

const ProtoCluster &

other

)

copy-assignment operator

operator==() [1/2]

bool eic::ProtoCluster::operator==

(

const ConstProtoCluster &

other

)

const

operator==() [2/2]

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

inline

unlink()

void eic::ProtoCluster::unlink ( )

inline

disconnect from ProtoClusterObj instance

weight() [1/3]

eic::Weight & eic::ProtoCluster::weight

(

)

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

weight() [2/3]

const eic::Weight & eic::ProtoCluster::weight

(

)

const

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

weight() [3/3]

void eic::ProtoCluster::weight

(

eic::Weight

value

)

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

Friends And Related Function Documentation

ConstProtoCluster

friend class ConstProtoCluster

friend

ProtoClusterCollection

friend class ProtoClusterCollection

friend

ProtoClusterCollectionIterator

friend class ProtoClusterCollectionIterator

friend

---

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

• eicd/ProtoCluster.h
• src/ProtoCluster.cc