eic::ConstMergedClusterRelations Class Reference

#include <MergedClusterRelationsConst.h>

Public Member Functions
	ConstMergedClusterRelations ()
	default constructor More...
	ConstMergedClusterRelations (eic::Index clusterID, std::uint32_t size, std::array< eic::Index, 4 > parent)
	ConstMergedClusterRelations (MergedClusterRelationsObj *obj)
	constructor from existing MergedClusterRelationsObj More...
	ConstMergedClusterRelations (const ConstMergedClusterRelations &other)
	copy constructor More...
ConstMergedClusterRelations &	operator= (const ConstMergedClusterRelations &other)
	copy-assignment operator More...
ConstMergedClusterRelations	clone () const
	support cloning (deep-copy) More...
	~ConstMergedClusterRelations ()
	destructor More...
const eic::Index &	clusterID () const
	Access the associated cluster ID. More...
const std::uint32_t &	size () const
	Access the number of valid parents. More...
const std::array< eic::Index, 4 > &	parent () const
	Access the (up to 4) parents for this cluster. More...
const eic::Index &	parent (size_t i) const
	Access item i of the (up to 4) parents for this cluster. More...
bool	isAvailable () const
	check whether the object is actually available More...
void	unlink ()
	disconnect from MergedClusterRelationsObj instance More...
bool	operator== (const ConstMergedClusterRelations &other) const
bool	operator== (const MergedClusterRelations &other) const
bool	operator< (const ConstMergedClusterRelations &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	MergedClusterRelations
class	MergedClusterRelationsCollection
class	MergedClusterRelationsConstCollectionIterator

Detailed Description

Relational info between a merged cluster and its parents

Author

: S. Joosten

Constructor & Destructor Documentation

ConstMergedClusterRelations() [1/4]

eic::ConstMergedClusterRelations::ConstMergedClusterRelations

(

)

default constructor

ConstMergedClusterRelations() [2/4]

eic::ConstMergedClusterRelations::ConstMergedClusterRelations	(	eic::Index	clusterID,
		std::uint32_t	size,
		std::array< eic::Index, 4 >	parent
	)

ConstMergedClusterRelations() [3/4]

eic::ConstMergedClusterRelations::ConstMergedClusterRelations

(

MergedClusterRelationsObj *

obj

)

constructor from existing MergedClusterRelationsObj

ConstMergedClusterRelations() [4/4]

eic::ConstMergedClusterRelations::ConstMergedClusterRelations

(

const ConstMergedClusterRelations &

other

)

copy constructor

~ConstMergedClusterRelations()

eic::ConstMergedClusterRelations::~ConstMergedClusterRelations

(

)

destructor

Member Function Documentation

clone()

ConstMergedClusterRelations eic::ConstMergedClusterRelations::clone

(

)

const

support cloning (deep-copy)

clusterID()

const eic::Index & eic::ConstMergedClusterRelations::clusterID

(

)

const

Access the associated cluster ID.

getObjectID()

const podio::ObjectID eic::ConstMergedClusterRelations::getObjectID

(

)

const

id()

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

inline

isAvailable()

bool eic::ConstMergedClusterRelations::isAvailable

(

)

const

check whether the object is actually available

operator<()

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

inline

operator=()

ConstMergedClusterRelations & eic::ConstMergedClusterRelations::operator=

(

const ConstMergedClusterRelations &

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool eic::ConstMergedClusterRelations::operator==

(

const MergedClusterRelations &

other

)

const

parent() [1/2]

const std::array< eic::Index, 4 > & eic::ConstMergedClusterRelations::parent

(

)

const

Access the (up to 4) parents for this cluster.

parent() [2/2]

const eic::Index & eic::ConstMergedClusterRelations::parent

(

size_t

i

)

const

Access item i of the (up to 4) parents for this cluster.

size()

const std::uint32_t & eic::ConstMergedClusterRelations::size

(

)

const

Access the number of valid parents.

unlink()

void eic::ConstMergedClusterRelations::unlink ( )

inline

disconnect from MergedClusterRelationsObj instance

Friends And Related Function Documentation

MergedClusterRelations

friend class MergedClusterRelations

friend

MergedClusterRelationsCollection

friend class MergedClusterRelationsCollection

friend

MergedClusterRelationsConstCollectionIterator

friend class MergedClusterRelationsConstCollectionIterator

friend

---

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

• eicd/MergedClusterRelationsConst.h
• src/MergedClusterRelationsConst.cc