o2::framework::InputSpan::InputSpanIterator< T > Class Template Reference

#include <InputSpan.h>

Inherits o2::framework::InputSpan::Iterator< InputSpan, T >.

Public Types
using	SelfType = InputSpanIterator
using	BaseType = Iterator< InputSpan, T >
using	value_type = typename BaseType::value_type
using	reference = typename BaseType::reference
using	pointer = typename BaseType::pointer
using	ElementType = typename std::remove_const< value_type >::type
using	iterator = Iterator< SelfType, T >
using	const_iterator = Iterator< SelfType, const T >
Public Types inherited from o2::framework::InputSpan::Iterator< InputSpan, T >
using	ParentType = InputSpan
using	SelfType = Iterator
using	iterator_category = std::forward_iterator_tag
using	value_type = T
using	reference = T &
using	pointer = T *
using	difference_type = std::ptrdiff_t
using	ElementType = typename std::remove_const< value_type >::type

Public Member Functions
	InputSpanIterator (InputSpan const *parent, bool isEnd=false)
DataRefIndices	initialIndices () const
	Initial indices for part-level iteration: first part starts at {headerIdx=0, payloadIdx=1}.
DataRefIndices	endIndices () const
	Sentinel used by nextIndicesGetter to signal end-of-slot.
ElementType	getAtIndices (DataRefIndices indices) const
	Get element at the given raw message indices in O(1).
DataRefIndices	nextIndices (DataRefIndices current) const
	Advance current to the next part's indices in O(1).
size_t	size () const
	Get number of parts in input slot.
const_iterator	begin () const
const_iterator	end () const
Public Member Functions inherited from o2::framework::InputSpan::Iterator< InputSpan, T >
	Iterator ()=delete
	Iterator (ParentType const *parent, bool isEnd=false)
SelfType &	operator++ ()
SelfType	operator++ (int)
reference	operator* () const
bool	operator== (const SelfType &rh) const
auto	operator<=> (const SelfType &rh) const
ParentType const *	parent () const
size_t	position () const

Detailed Description

template<typename T>
class o2::framework::InputSpan::InputSpanIterator< T >

An iterator over the input slots. It supports an iterator interface to access the parts in the slot.

Definition at line 192 of file InputSpan.h.

Member Typedef Documentation

BaseType

template<typename T >

using o2::framework::InputSpan::InputSpanIterator< T >::BaseType = Iterator<InputSpan, T>

Definition at line 196 of file InputSpan.h.

const_iterator

template<typename T >

using o2::framework::InputSpan::InputSpanIterator< T >::const_iterator = Iterator<SelfType, const T>

Definition at line 202 of file InputSpan.h.

ElementType

template<typename T >

using o2::framework::InputSpan::InputSpanIterator< T >::ElementType = typename std::remove_const<value_type>::type

Definition at line 200 of file InputSpan.h.

iterator

template<typename T >

using o2::framework::InputSpan::InputSpanIterator< T >::iterator = Iterator<SelfType, T>

Definition at line 201 of file InputSpan.h.

pointer

template<typename T >

using o2::framework::InputSpan::InputSpanIterator< T >::pointer = typename BaseType::pointer

Definition at line 199 of file InputSpan.h.

reference

template<typename T >

using o2::framework::InputSpan::InputSpanIterator< T >::reference = typename BaseType::reference

Definition at line 198 of file InputSpan.h.

SelfType

template<typename T >

using o2::framework::InputSpan::InputSpanIterator< T >::SelfType = InputSpanIterator

Definition at line 195 of file InputSpan.h.

value_type

template<typename T >

using o2::framework::InputSpan::InputSpanIterator< T >::value_type = typename BaseType::value_type

Definition at line 197 of file InputSpan.h.

Constructor & Destructor Documentation

InputSpanIterator()

template<typename T >

o2::framework::InputSpan::InputSpanIterator< T >::InputSpanIterator ( InputSpan const *  parent, bool  isEnd = false  )

inline

Definition at line 204 of file InputSpan.h.

Member Function Documentation

begin()

template<typename T >

const_iterator o2::framework::InputSpan::InputSpanIterator< T >::begin ( ) const

inline

Definition at line 232 of file InputSpan.h.

end()

template<typename T >

const_iterator o2::framework::InputSpan::InputSpanIterator< T >::end ( ) const

inline

Definition at line 237 of file InputSpan.h.

endIndices()

template<typename T >

DataRefIndices o2::framework::InputSpan::InputSpanIterator< T >::endIndices ( ) const

inline

Sentinel used by nextIndicesGetter to signal end-of-slot.

Definition at line 212 of file InputSpan.h.

getAtIndices()

template<typename T >

ElementType o2::framework::InputSpan::InputSpanIterator< T >::getAtIndices ( DataRefIndices  indices ) const

inline

Get element at the given raw message indices in O(1).

Definition at line 215 of file InputSpan.h.

initialIndices()

template<typename T >

DataRefIndices o2::framework::InputSpan::InputSpanIterator< T >::initialIndices ( ) const

inline

Initial indices for part-level iteration: first part starts at {headerIdx=0, payloadIdx=1}.

Definition at line 210 of file InputSpan.h.

nextIndices()

template<typename T >

DataRefIndices o2::framework::InputSpan::InputSpanIterator< T >::nextIndices ( DataRefIndices  current ) const

inline

Advance current to the next part's indices in O(1).

Definition at line 221 of file InputSpan.h.

size()

template<typename T >

size_t o2::framework::InputSpan::InputSpanIterator< T >::size ( ) const

inline

Get number of parts in input slot.

Definition at line 227 of file InputSpan.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Framework/Core/include/Framework/InputSpan.h