DABC (Data Acquisition Backbone Core)  2.9.9
Public Member Functions | Static Public Member Functions | Protected Attributes
hadaq::ReadIterator Class Reference

Read iterator for HADAQ events/subevents. More...

#include <hadaq/Iterator.h>

Public Member Functions

bool AssignEventPointer (dabc::Pointer &ptr)
 
void Close ()
 
hadaq::RawEventevnt () const
 
unsigned evntsize () const
 
hadaq::HadTuhadtu () const
 
bool IsData () const
 
bool NextEvent ()
 Used for ready HLD events. More...
 
bool NextHadTu ()
 Used for raw data from TRBs. More...
 
bool NextSubEvent ()
 Used for sub-events iteration inside current block. More...
 
bool NextSubeventsBlock ()
 Depending from buffer type calls NextHadTu() or NextEvent() More...
 
ReadIteratoroperator= (const ReadIterator &src)
 
void * rawdata () const
 
unsigned rawdata_maxsize () const
 Try to define maximal length for the raw data. More...
 
uint32_t rawdatasize () const
 
 ReadIterator ()
 
 ReadIterator (const dabc::Buffer &buf)
 
 ReadIterator (const ReadIterator &src)
 
unsigned remained_size () const
 Returns size used by current event plus rest. More...
 
bool Reset ()
 Reset iterator - forget pointer on buffer. More...
 
bool Reset (const dabc::Buffer &buf)
 Initialize iterator on the beginning of the buffer, buffer instance should exists until end of iterator usage. More...
 
hadaq::RawSubeventsubevnt () const
 
 ~ReadIterator ()
 

Static Public Member Functions

static unsigned NumEvents (const dabc::Buffer &buf)
 

Protected Attributes

unsigned fBufType
 
dabc::Pointer fEvPtr
 
bool fFirstEvent
 
dabc::Pointer fRawPtr
 
dabc::Pointer fSubPtr
 

Detailed Description

Read iterator for HADAQ events/subevents.

Definition at line 39 of file Iterator.h.

Constructor & Destructor Documentation

◆ ReadIterator() [1/3]

hadaq::ReadIterator::ReadIterator ( )

Definition at line 20 of file Iterator.cxx.

◆ ReadIterator() [2/3]

hadaq::ReadIterator::ReadIterator ( const dabc::Buffer buf)

Definition at line 29 of file Iterator.cxx.

◆ ReadIterator() [3/3]

hadaq::ReadIterator::ReadIterator ( const ReadIterator src)

Definition at line 39 of file Iterator.cxx.

◆ ~ReadIterator()

hadaq::ReadIterator::~ReadIterator ( )
inline

Definition at line 56 of file Iterator.h.

Member Function Documentation

◆ operator=()

hadaq::ReadIterator & hadaq::ReadIterator::operator= ( const ReadIterator src)

Definition at line 48 of file Iterator.cxx.

◆ Reset() [1/2]

bool hadaq::ReadIterator::Reset ( const dabc::Buffer buf)

Initialize iterator on the beginning of the buffer, buffer instance should exists until end of iterator usage.

Definition at line 59 of file Iterator.cxx.

◆ Reset() [2/2]

bool hadaq::ReadIterator::Reset ( )
inline

Reset iterator - forget pointer on buffer.

Definition at line 63 of file Iterator.h.

◆ Close()

void hadaq::ReadIterator::Close ( )

Definition at line 78 of file Iterator.cxx.

◆ IsData()

bool hadaq::ReadIterator::IsData ( ) const
inline

Definition at line 67 of file Iterator.h.

◆ NextHadTu()

bool hadaq::ReadIterator::NextHadTu ( )

Used for raw data from TRBs.

Definition at line 88 of file Iterator.cxx.

◆ NextEvent()

bool hadaq::ReadIterator::NextEvent ( )

Used for ready HLD events.

Definition at line 127 of file Iterator.cxx.

◆ NextSubeventsBlock()

bool hadaq::ReadIterator::NextSubeventsBlock ( )

Depending from buffer type calls NextHadTu() or NextEvent()

Definition at line 166 of file Iterator.cxx.

◆ NextSubEvent()

bool hadaq::ReadIterator::NextSubEvent ( )

Used for sub-events iteration inside current block.

Definition at line 199 of file Iterator.cxx.

◆ evnt()

hadaq::RawEvent* hadaq::ReadIterator::evnt ( ) const
inline

Definition at line 81 of file Iterator.h.

◆ evntsize()

unsigned hadaq::ReadIterator::evntsize ( ) const
inline

Definition at line 82 of file Iterator.h.

◆ remained_size()

unsigned hadaq::ReadIterator::remained_size ( ) const
inline

Returns size used by current event plus rest.

Definition at line 85 of file Iterator.h.

◆ hadtu()

hadaq::HadTu* hadaq::ReadIterator::hadtu ( ) const
inline

Definition at line 87 of file Iterator.h.

◆ AssignEventPointer()

bool hadaq::ReadIterator::AssignEventPointer ( dabc::Pointer ptr)

Definition at line 188 of file Iterator.cxx.

◆ subevnt()

hadaq::RawSubevent* hadaq::ReadIterator::subevnt ( ) const
inline

Definition at line 90 of file Iterator.h.

◆ rawdata()

void* hadaq::ReadIterator::rawdata ( ) const
inline

Definition at line 91 of file Iterator.h.

◆ rawdatasize()

uint32_t hadaq::ReadIterator::rawdatasize ( ) const
inline

Definition at line 92 of file Iterator.h.

◆ rawdata_maxsize()

unsigned hadaq::ReadIterator::rawdata_maxsize ( ) const

Try to define maximal length for the raw data.

Definition at line 252 of file Iterator.cxx.

◆ NumEvents()

unsigned hadaq::ReadIterator::NumEvents ( const dabc::Buffer buf)
static

Definition at line 259 of file Iterator.cxx.

Field Documentation

◆ fFirstEvent

bool hadaq::ReadIterator::fFirstEvent
protected

Definition at line 41 of file Iterator.h.

◆ fEvPtr

dabc::Pointer hadaq::ReadIterator::fEvPtr
protected

Definition at line 42 of file Iterator.h.

◆ fSubPtr

dabc::Pointer hadaq::ReadIterator::fSubPtr
protected

Definition at line 43 of file Iterator.h.

◆ fRawPtr

dabc::Pointer hadaq::ReadIterator::fRawPtr
protected

Definition at line 44 of file Iterator.h.

◆ fBufType

unsigned hadaq::ReadIterator::fBufType
protected

Definition at line 45 of file Iterator.h.


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