o2::emcal::ClusterFactory< InputType >::ClusterIterator Class Reference

#include <ClusterFactory.h>

Public Member Functions
	ClusterIterator (const ClusterFactory &factory, int clusterIndex, bool forward)
	Constructor, initializing the iterator.
	~ClusterIterator ()=default
	Destructor.
bool	operator== (const ClusterIterator &rhs) const
	Check for equalness.
bool	operator!= (const ClusterIterator &rhs) const
	Check for not equalness.
ClusterIterator &	operator++ ()
	Prefix incrementation operator.
ClusterIterator	operator++ (int)
	Postfix incrementation operator.
ClusterIterator &	operator-- ()
	Prefix decrementation operator.
ClusterIterator	operator-- (int)
	Postfix decrementation operator.
AnalysisCluster *	operator* ()
	Get pointer to the current cluster.
AnalysisCluster &	operator& ()
	Get reference to the current cluster.
int	current_index () const
	Get the index of the current event.

Detailed Description

template<class InputType>
class o2::emcal::ClusterFactory< InputType >::ClusterIterator

Definition at line 131 of file ClusterFactory.h.

Constructor & Destructor Documentation

ClusterIterator()

template<class InputType >

ClusterFactory::ClusterIterator::ClusterIterator	(	const ClusterFactory &	factory,
		int	clusterIndex,
		bool	forward
	)

Constructor, initializing the iterator.

Parameters

factory	cluster factory to iterate over
clusterIndex	cluster ID from which to start the iteration
forward	Direction of the iteration (true = forward)

Definition at line 839 of file ClusterFactory.cxx.

~ClusterIterator()

template<class InputType >

o2::emcal::ClusterFactory< InputType >::ClusterIterator::~ClusterIterator ( )

default

Destructor.

Member Function Documentation

current_index()

template<class InputType >

int o2::emcal::ClusterFactory< InputType >::ClusterIterator::current_index ( ) const

inline

Get the index of the current event.

Returns

Index of the current event

Definition at line 183 of file ClusterFactory.h.

operator!=()

template<class InputType >

bool o2::emcal::ClusterFactory< InputType >::ClusterIterator::operator!= ( const ClusterIterator &  rhs ) const

inline

Check for not equalness.

Parameters

rhs	Iterator to compare to

Returns

True if iterators are different, false otherwise

Check is done on same event factory, event ID and direction

Definition at line 155 of file ClusterFactory.h.

operator&()

template<class InputType >

AnalysisCluster & o2::emcal::ClusterFactory< InputType >::ClusterIterator::operator& ( )

inline

Get reference to the current cluster.

Returns

Reference to the current event of the iterator

Definition at line 179 of file ClusterFactory.h.

operator*()

template<class InputType >

AnalysisCluster * o2::emcal::ClusterFactory< InputType >::ClusterIterator::operator* ( )

inline

Get pointer to the current cluster.

Returns

Pointer to the current event

Definition at line 175 of file ClusterFactory.h.

operator++() [1/2]

template<class InputType >

ClusterFactory< InputType >::ClusterIterator & ClusterFactory::ClusterIterator::operator++

(

)

Prefix incrementation operator.

Returns

Iterator after incrementation

Definition at line 854 of file ClusterFactory.cxx.

operator++() [2/2]

template<class InputType >

ClusterFactory< InputType >::ClusterIterator ClusterFactory::ClusterIterator::operator++

(

int

)

Postfix incrementation operator.

Returns

Iterator before incrementation

Definition at line 866 of file ClusterFactory.cxx.

operator--() [1/2]

template<class InputType >

ClusterFactory< InputType >::ClusterIterator & ClusterFactory::ClusterIterator::operator--

(

)

Prefix decrementation operator.

Returns

Iterator after decrementation

Definition at line 874 of file ClusterFactory.cxx.

operator--() [2/2]

template<class InputType >

ClusterFactory< InputType >::ClusterIterator ClusterFactory::ClusterIterator::operator--

(

int

)

Postfix decrementation operator.

Returns

Iterator before decrementation

Definition at line 886 of file ClusterFactory.cxx.

operator==()

template<class InputType >

bool ClusterFactory::ClusterIterator::operator==

(

const ClusterIterator &

rhs

)

const

Check for equalness.

Parameters

rhs	Iterator to compare to

Returns

True if iterators are the same, false otherwise

Check is done on same event factory, event ID and direction

Definition at line 848 of file ClusterFactory.cxx.

---

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

• /home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/base/include/EMCALBase/ClusterFactory.h
• /home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/base/src/ClusterFactory.cxx