Project
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
o2::framework::InputSpan Class Reference

#include <InputSpan.h>

Classes

class  Iterator
 
struct  PartRange
 A range over the parts of a single slot, supporting range-based for. More...
 

Public Types

using const_iterator = Iterator< InputSpan, const DataRef >
 
using iterator = const_iterator
 

Public Member Functions

 InputSpan ()=delete
 
 InputSpan (InputSpan const &)=delete
 
 InputSpan (InputSpan &&)=default
 
 InputSpan (std::function< size_t(size_t)> nofPartsGetter, std::function< int(size_t)> refCountGetter, std::function< DataRef(size_t, DataRefIndices)> indicesGetter, std::function< DataRefIndices(size_t, DataRefIndices)> nextIndicesGetter, std::function< fair::mq::Message *(size_t, DataRefIndices)> payloadGetter, size_t size)
 
DataRef get (size_t i, size_t partidx=0) const
 i-th element of the InputSpan (O(partidx) sequential scan via indices protocol)
 
DataRef getAtIndices (size_t slotIdx, DataRefIndices indices) const
 Return the DataRef for the part described by indices in slot slotIdx in O(1).
 
fair::mq::Message * getPayloadAtIndices (size_t slotIdx, DataRefIndices indices) const
 Return the payload as fair::mq::Message* for the part described by indices in slot slotIdx.
 
DataRefIndices nextIndices (size_t slotIdx, DataRefIndices current) const
 Advance from current to the indices of the next part in slot slotIdx in O(1).
 
DataRefIndices initialIndices () const
 
DataRefIndices endIndices () const
 
DataRef getAtIndices (DataRefIndices indices) const
 
DataRefIndices nextIndices (DataRefIndices current) const
 
size_t getNofParts (size_t i) const
 number of parts in the i-th element of the InputSpan
 
int getRefCount (size_t i) const
 
size_t size () const
 Number of elements in the InputSpan.
 
const char * header (size_t i) const
 
const char * payload (size_t i) const
 
PartRange parts (size_t i) const
 Return an iterable range over all parts in slot i.
 
const_iterator begin () const
 
const_iterator end () const
 

Detailed Description

Mapping helper between the store of all inputs being processed and the actual inputs to be processed in a given go. In general this will use an helper which returns fair::mq::Message->GetData() from the Message cache, but in principle the mechanism should be flexible enough to allow all kind of input stores.

Definition at line 30 of file InputSpan.h.

Member Typedef Documentation

◆ const_iterator

using o2::framework::InputSpan::const_iterator = Iterator<InputSpan, const DataRef>

Definition at line 230 of file InputSpan.h.

◆ iterator

using o2::framework::InputSpan::iterator = const_iterator

Definition at line 231 of file InputSpan.h.

Constructor & Destructor Documentation

◆ InputSpan() [1/4]

o2::framework::InputSpan::InputSpan ( )
delete

◆ InputSpan() [2/4]

o2::framework::InputSpan::InputSpan ( InputSpan const &  )
delete

◆ InputSpan() [3/4]

o2::framework::InputSpan::InputSpan ( InputSpan &&  )
default

◆ InputSpan() [4/4]

o2::framework::InputSpan::InputSpan ( std::function< size_t(size_t)>  nofPartsGetter,
std::function< int(size_t)>  refCountGetter,
std::function< DataRef(size_t, DataRefIndices)>  indicesGetter,
std::function< DataRefIndices(size_t, DataRefIndices)>  nextIndicesGetter,
std::function< fair::mq::Message *(size_t, DataRefIndices)>  payloadGetter,
size_t  size 
)

Navigate the message store via the DataRefIndices protocol. get_next_pair (DataModelViews.h) provides O(1) sequential advancement for nextIndicesGetter.

Definition at line 20 of file InputSpan.cxx.

Member Function Documentation

◆ begin()

const_iterator o2::framework::InputSpan::begin ( ) const
inline

Definition at line 234 of file InputSpan.h.

◆ end()

const_iterator o2::framework::InputSpan::end ( ) const
inline

Definition at line 239 of file InputSpan.h.

◆ endIndices()

DataRefIndices o2::framework::InputSpan::endIndices ( ) const
inline

Definition at line 76 of file InputSpan.h.

◆ get()

DataRef o2::framework::InputSpan::get ( size_t  i,
size_t  partidx = 0 
) const
inline

i-th element of the InputSpan (O(partidx) sequential scan via indices protocol)

Definition at line 47 of file InputSpan.h.

◆ getAtIndices() [1/2]

DataRef o2::framework::InputSpan::getAtIndices ( DataRefIndices  indices) const
inline

Definition at line 77 of file InputSpan.h.

◆ getAtIndices() [2/2]

DataRef o2::framework::InputSpan::getAtIndices ( size_t  slotIdx,
DataRefIndices  indices 
) const
inline

Return the DataRef for the part described by indices in slot slotIdx in O(1).

Definition at line 57 of file InputSpan.h.

◆ getNofParts()

size_t o2::framework::InputSpan::getNofParts ( size_t  i) const
inline

number of parts in the i-th element of the InputSpan

Definition at line 81 of file InputSpan.h.

◆ getPayloadAtIndices()

fair::mq::Message * o2::framework::InputSpan::getPayloadAtIndices ( size_t  slotIdx,
DataRefIndices  indices 
) const
inline

Return the payload as fair::mq::Message* for the part described by indices in slot slotIdx.

Definition at line 63 of file InputSpan.h.

◆ getRefCount()

int o2::framework::InputSpan::getRefCount ( size_t  i) const
inline

Definition at line 90 of file InputSpan.h.

◆ header()

const char * o2::framework::InputSpan::header ( size_t  i) const
inline

Definition at line 107 of file InputSpan.h.

◆ initialIndices()

DataRefIndices o2::framework::InputSpan::initialIndices ( ) const
inline

Definition at line 75 of file InputSpan.h.

◆ nextIndices() [1/2]

DataRefIndices o2::framework::InputSpan::nextIndices ( DataRefIndices  current) const
inline

Definition at line 78 of file InputSpan.h.

◆ nextIndices() [2/2]

DataRefIndices o2::framework::InputSpan::nextIndices ( size_t  slotIdx,
DataRefIndices  current 
) const
inline

Advance from current to the indices of the next part in slot slotIdx in O(1).

Definition at line 69 of file InputSpan.h.

◆ parts()

PartRange o2::framework::InputSpan::parts ( size_t  i) const
inline

Return an iterable range over all parts in slot i.

Definition at line 228 of file InputSpan.h.

◆ payload()

const char * o2::framework::InputSpan::payload ( size_t  i) const
inline

Definition at line 112 of file InputSpan.h.

◆ size()

size_t o2::framework::InputSpan::size ( ) const
inline

Number of elements in the InputSpan.

Definition at line 102 of file InputSpan.h.

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