eic::MergedClusterRelations Class Reference

#include <MergedClusterRelations.h>

Public Member Functions
	MergedClusterRelations ()
	default constructor More...
	MergedClusterRelations (eic::Index clusterID, std::uint32_t size, std::array< eic::Index, 4 > parent)
	MergedClusterRelations (MergedClusterRelationsObj *obj)
	constructor from existing MergedClusterRelationsObj More...
	MergedClusterRelations (const MergedClusterRelations &other)
	copy constructor More...
MergedClusterRelations &	operator= (const MergedClusterRelations &other)
	copy-assignment operator More...
MergedClusterRelations	clone () const
	support cloning (deep-copy) More...
	~MergedClusterRelations ()
	destructor More...
	operator ConstMergedClusterRelations () const
	conversion to const object 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...
void	clusterID (eic::Index value)
	Set the associated cluster ID. More...
eic::Index &	clusterID ()
	Get reference to associated cluster ID. More...
void	size (std::uint32_t value)
	Set the number of valid parents. More...
void	parent (std::array< eic::Index, 4 > value)
	Set the (up to 4) parents for this cluster. More...
void	parent (size_t i, eic::Index value)
std::array< eic::Index, 4 > &	parent ()
	Get reference to (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 MergedClusterRelations &other) const
bool	operator== (const ConstMergedClusterRelations &other) const
bool	operator< (const MergedClusterRelations &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	MergedClusterRelationsCollection
class	MergedClusterRelationsCollectionIterator
class	ConstMergedClusterRelations

Detailed Description

Relational info between a merged cluster and its parents

Author

: S. Joosten

Constructor & Destructor Documentation

MergedClusterRelations() [1/4]

eic::MergedClusterRelations::MergedClusterRelations

(

)

default constructor

MergedClusterRelations() [2/4]

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

MergedClusterRelations() [3/4]

eic::MergedClusterRelations::MergedClusterRelations

(

MergedClusterRelationsObj *

obj

)

constructor from existing MergedClusterRelationsObj

MergedClusterRelations() [4/4]

eic::MergedClusterRelations::MergedClusterRelations

(

const MergedClusterRelations &

other

)

copy constructor

~MergedClusterRelations()

eic::MergedClusterRelations::~MergedClusterRelations

(

)

destructor

Member Function Documentation

clone()

MergedClusterRelations eic::MergedClusterRelations::clone

(

)

const

support cloning (deep-copy)

clusterID() [1/3]

eic::Index & eic::MergedClusterRelations::clusterID

(

)

Get reference to associated cluster ID.

clusterID() [2/3]

const eic::Index & eic::MergedClusterRelations::clusterID

(

)

const

Access the associated cluster ID.

clusterID() [3/3]

void eic::MergedClusterRelations::clusterID

(

eic::Index

value

)

Set the associated cluster ID.

getObjectID()

const podio::ObjectID eic::MergedClusterRelations::getObjectID

(

)

const

id()

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

inline

isAvailable()

bool eic::MergedClusterRelations::isAvailable

(

)

const

check whether the object is actually available

operator ConstMergedClusterRelations()

eic::MergedClusterRelations::operator ConstMergedClusterRelations

(

)

const

conversion to const object

operator<()

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

inline

operator=()

MergedClusterRelations & eic::MergedClusterRelations::operator=

(

const MergedClusterRelations &

other

)

copy-assignment operator

operator==() [1/2]

bool eic::MergedClusterRelations::operator==

(

const ConstMergedClusterRelations &

other

)

const

operator==() [2/2]

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

inline

parent() [1/5]

std::array< eic::Index, 4 > & eic::MergedClusterRelations::parent

(

)

Get reference to (up to 4) parents for this cluster.

parent() [2/5]

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

(

)

const

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

parent() [3/5]

const eic::Index & eic::MergedClusterRelations::parent

(

size_t

i

)

const

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

parent() [4/5]

void eic::MergedClusterRelations::parent	(	size_t	i,
		eic::Index	value
	)

parent() [5/5]

void eic::MergedClusterRelations::parent

(

std::array< eic::Index, 4 >

value

)

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

size() [1/2]

const std::uint32_t & eic::MergedClusterRelations::size

(

)

const

Access the number of valid parents.

size() [2/2]

void eic::MergedClusterRelations::size

(

std::uint32_t

value

)

Set the number of valid parents.

unlink()

void eic::MergedClusterRelations::unlink ( )

inline

disconnect from MergedClusterRelationsObj instance

Friends And Related Function Documentation

ConstMergedClusterRelations

friend class ConstMergedClusterRelations

friend

MergedClusterRelationsCollection

friend class MergedClusterRelationsCollection

friend

MergedClusterRelationsCollectionIterator

friend class MergedClusterRelationsCollectionIterator

friend

---

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

• eicd/MergedClusterRelations.h
• src/MergedClusterRelations.cc