eic::Cluster3DInfo Class Reference

#include <Cluster3DInfo.h>

Public Member Functions
	Cluster3DInfo ()
	default constructor More...
	Cluster3DInfo (eic::Index clusterID, eic::VectorPolar polar, float eta, eic::Direction direction)
	Cluster3DInfo (Cluster3DInfoObj *obj)
	constructor from existing Cluster3DInfoObj More...
	Cluster3DInfo (const Cluster3DInfo &other)
	copy constructor More...
Cluster3DInfo &	operator= (const Cluster3DInfo &other)
	copy-assignment operator More...
Cluster3DInfo	clone () const
	support cloning (deep-copy) More...
	~Cluster3DInfo ()
	destructor More...
	operator ConstCluster3DInfo () 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...
const eic::Direction &	direction () const
	Access the Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi]. 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...
void	direction (eic::Direction value)
	Set the Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi]. More...
eic::Direction &	direction ()
	Get reference to Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi]. More...
bool	isAvailable () const
	check whether the object is actually available More...
void	unlink ()
	disconnect from Cluster3DInfoObj instance More...
bool	operator== (const Cluster3DInfo &other) const
bool	operator== (const ConstCluster3DInfo &other) const
bool	operator< (const Cluster3DInfo &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	Cluster3DInfoCollection
class	Cluster3DInfoCollectionIterator
class	ConstCluster3DInfo

Detailed Description

Additional info for 3D clusters

Author

: S. Joosten

Constructor & Destructor Documentation

Cluster3DInfo() [1/4]

eic::Cluster3DInfo::Cluster3DInfo

(

)

default constructor

Cluster3DInfo() [2/4]

eic::Cluster3DInfo::Cluster3DInfo	(	eic::Index	clusterID,
		eic::VectorPolar	polar,
		float	eta,
		eic::Direction	direction
	)

Cluster3DInfo() [3/4]

eic::Cluster3DInfo::Cluster3DInfo

(

Cluster3DInfoObj *

obj

)

constructor from existing Cluster3DInfoObj

Cluster3DInfo() [4/4]

eic::Cluster3DInfo::Cluster3DInfo

(

const Cluster3DInfo &

other

)

copy constructor

~Cluster3DInfo()

eic::Cluster3DInfo::~Cluster3DInfo

(

)

destructor

Member Function Documentation

clone()

Cluster3DInfo eic::Cluster3DInfo::clone

(

)

const

support cloning (deep-copy)

clusterID() [1/3]

eic::Index & eic::Cluster3DInfo::clusterID

(

)

Get reference to Primary cluster ID.

clusterID() [2/3]

const eic::Index & eic::Cluster3DInfo::clusterID

(

)

const

Access the Primary cluster ID.

clusterID() [3/3]

void eic::Cluster3DInfo::clusterID

(

eic::Index

value

)

Set the Primary cluster ID.

direction() [1/3]

eic::Direction & eic::Cluster3DInfo::direction

(

)

Get reference to Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi].

direction() [2/3]

const eic::Direction & eic::Cluster3DInfo::direction

(

)

const

Access the Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi].

direction() [3/3]

void eic::Cluster3DInfo::direction

(

eic::Direction

value

)

Set the Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi].

eta() [1/2]

const float & eic::Cluster3DInfo::eta

(

)

const

Access the Cluster pseudorapidity.

eta() [2/2]

void eic::Cluster3DInfo::eta

(

float

value

)

Set the Cluster pseudorapidity.

getObjectID()

const podio::ObjectID eic::Cluster3DInfo::getObjectID

(

)

const

id()

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

inline

isAvailable()

bool eic::Cluster3DInfo::isAvailable

(

)

const

check whether the object is actually available

operator ConstCluster3DInfo()

eic::Cluster3DInfo::operator ConstCluster3DInfo

(

)

const

conversion to const object

operator<()

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

inline

operator=()

Cluster3DInfo & eic::Cluster3DInfo::operator=

(

const Cluster3DInfo &

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool eic::Cluster3DInfo::operator==

(

const ConstCluster3DInfo &

other

)

const

polar() [1/3]

eic::VectorPolar & eic::Cluster3DInfo::polar

(

)

Get reference to Cluster position polar information.

polar() [2/3]

const eic::VectorPolar & eic::Cluster3DInfo::polar

(

)

const

Access the Cluster position polar information.

polar() [3/3]

void eic::Cluster3DInfo::polar

(

eic::VectorPolar

value

)

Set the Cluster position polar information.

unlink()

void eic::Cluster3DInfo::unlink ( )

inline

disconnect from Cluster3DInfoObj instance

Friends And Related Function Documentation

Cluster3DInfoCollection

friend class Cluster3DInfoCollection

friend

Cluster3DInfoCollectionIterator

friend class Cluster3DInfoCollectionIterator

friend

ConstCluster3DInfo

friend class ConstCluster3DInfo

friend

---

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

• eicd/Cluster3DInfo.h
• src/Cluster3DInfo.cc