eic::Cluster2DInfo Class Reference

#include <Cluster2DInfo.h>

Public Member Functions
	Cluster2DInfo ()
	default constructor More...
	Cluster2DInfo (eic::Index clusterID, eic::VectorPolar polar, float eta)
	Cluster2DInfo (Cluster2DInfoObj *obj)
	constructor from existing Cluster2DInfoObj More...
	Cluster2DInfo (const Cluster2DInfo &other)
	copy constructor More...
Cluster2DInfo &	operator= (const Cluster2DInfo &other)
	copy-assignment operator More...
Cluster2DInfo	clone () const
	support cloning (deep-copy) More...
	~Cluster2DInfo ()
	destructor More...
	operator ConstCluster2DInfo () const
	conversion to const object More...
const eic::Index &	clusterID () const
	Access the Primary cluster ID. More...
const eic::VectorPolar &	polar () const
	Access the Cluster position polar information. More...
const float &	eta () const
	Access the Cluster pseudorapidity. More...
void	clusterID (eic::Index value)
	Set the Primary cluster ID. More...
eic::Index &	clusterID ()
	Get reference to Primary cluster ID. More...
void	polar (eic::VectorPolar value)
	Set the Cluster position polar information. More...
eic::VectorPolar &	polar ()
	Get reference to Cluster position polar information. More...
void	eta (float value)
	Set the Cluster pseudorapidity. More...
bool	isAvailable () const
	check whether the object is actually available More...
void	unlink ()
	disconnect from Cluster2DInfoObj instance More...
bool	operator== (const Cluster2DInfo &other) const
bool	operator== (const ConstCluster2DInfo &other) const
bool	operator< (const Cluster2DInfo &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	Cluster2DInfoCollection
class	Cluster2DInfoCollectionIterator
class	ConstCluster2DInfo

Detailed Description

Additional info for 3D clusters

Author

: S. Joosten

Constructor & Destructor Documentation

Cluster2DInfo() [1/4]

eic::Cluster2DInfo::Cluster2DInfo

(

)

default constructor

Cluster2DInfo() [2/4]

eic::Cluster2DInfo::Cluster2DInfo	(	eic::Index	clusterID,
		eic::VectorPolar	polar,
		float	eta
	)

Cluster2DInfo() [3/4]

eic::Cluster2DInfo::Cluster2DInfo

(

Cluster2DInfoObj *

obj

)

constructor from existing Cluster2DInfoObj

Cluster2DInfo() [4/4]

eic::Cluster2DInfo::Cluster2DInfo

(

const Cluster2DInfo &

other

)

copy constructor

~Cluster2DInfo()

eic::Cluster2DInfo::~Cluster2DInfo

(

)

destructor

Member Function Documentation

clone()

Cluster2DInfo eic::Cluster2DInfo::clone

(

)

const

support cloning (deep-copy)

clusterID() [1/3]

eic::Index & eic::Cluster2DInfo::clusterID

(

)

Get reference to Primary cluster ID.

clusterID() [2/3]

const eic::Index & eic::Cluster2DInfo::clusterID

(

)

const

Access the Primary cluster ID.

clusterID() [3/3]

void eic::Cluster2DInfo::clusterID

(

eic::Index

value

)

Set the Primary cluster ID.

eta() [1/2]

const float & eic::Cluster2DInfo::eta

(

)

const

Access the Cluster pseudorapidity.

eta() [2/2]

void eic::Cluster2DInfo::eta

(

float

value

)

Set the Cluster pseudorapidity.

getObjectID()

const podio::ObjectID eic::Cluster2DInfo::getObjectID

(

)

const

id()

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

inline

isAvailable()

bool eic::Cluster2DInfo::isAvailable

(

)

const

check whether the object is actually available

operator ConstCluster2DInfo()

eic::Cluster2DInfo::operator ConstCluster2DInfo

(

)

const

conversion to const object

operator<()

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

inline

operator=()

Cluster2DInfo & eic::Cluster2DInfo::operator=

(

const Cluster2DInfo &

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool eic::Cluster2DInfo::operator==

(

const ConstCluster2DInfo &

other

)

const

polar() [1/3]

eic::VectorPolar & eic::Cluster2DInfo::polar

(

)

Get reference to Cluster position polar information.

polar() [2/3]

const eic::VectorPolar & eic::Cluster2DInfo::polar

(

)

const

Access the Cluster position polar information.

polar() [3/3]

void eic::Cluster2DInfo::polar

(

eic::VectorPolar

value

)

Set the Cluster position polar information.

unlink()

void eic::Cluster2DInfo::unlink ( )

inline

disconnect from Cluster2DInfoObj instance

Friends And Related Function Documentation

Cluster2DInfoCollection

friend class Cluster2DInfoCollection

friend

Cluster2DInfoCollectionIterator

friend class Cluster2DInfoCollectionIterator

friend

ConstCluster2DInfo

friend class ConstCluster2DInfo

friend

---

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

• eicd/Cluster2DInfo.h
• src/Cluster2DInfo.cc