Project
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | List of all members
o2::emcal::RawReaderMemory Class Reference
EMCAL » EMCAL reconstruction

Reader for raw data produced by the Readout application in in-memory format. More...

#include <RawReaderMemory.h>

Classes

class  MinorError
 Minor (non-crashing) raw decoding errors. More...
 

Public Member Functions

 RawReaderMemory (const gsl::span< const char > rawmemory)
 Constructor.
 
 ~RawReaderMemory ()=default
 Destructor.
 
void setRawMemory (const gsl::span< const char > rawmemory)
 set new raw memory chunk
 
void setRangeSRUDDLs (uint16_t minDDL, uint16_t maxDDL)
 Set range for DDLs from SRU (for RCU trailer merging)
 
void next ()
 Read next payload from the stream.
 
void nextPage (bool resetPayload=true)
 Read the next page from the stream (single DMA page)
 
const o2::header::RDHAny & getRawHeader () const
 access to the raw header of the current page
 
const RawBuffer & getRawBuffer () const
 access to the raw buffer (single DMA page)
 
const RawPayload & getPayload () const
 access to the full raw payload (single or multiple DMA pages)
 
gsl::span< const MinorError > getMinorErrors () const
 Get minor (non-crashing) raw decoding errors.
 
int getPayloadSize () const
 Return size of the payload.
 
int getFileSize () const noexcept
 get the size of the file in bytes
 
bool hasNext () const
 check if more pages are available in the raw file
 

Protected Member Functions

void init ()
 Initialize the raw stream.
 
o2::header::RDHAny decodeRawHeader (const void *headerwords)
 Decode raw header words.
 

Detailed Description

Reader for raw data produced by the Readout application in in-memory format.

Author
Markus Fasel marku.nosp@m.s.fa.nosp@m.sel@c.nosp@m.ern..nosp@m.ch, Oak Ridge National Laboratory
Since
Nov. 14, 2019

Definition at line 38 of file RawReaderMemory.h.

Constructor & Destructor Documentation

◆ RawReaderMemory()

RawReaderMemory::RawReaderMemory ( const gsl::span< const char >  rawmemory)

Constructor.

Definition at line 23 of file RawReaderMemory.cxx.

◆ ~RawReaderMemory()

o2::emcal::RawReaderMemory::~RawReaderMemory ( )
default

Destructor.

Member Function Documentation

◆ decodeRawHeader()

o2::header::RDHAny RawReaderMemory::decodeRawHeader ( const void *  headerwords)
protected

Decode raw header words.

Parameters
headerwordsHeaderwords
Returns
Decoded RDH
Exceptions
RawDecodingErrorwith code HEADER_DECODING if the payload does not correspond to an expected header

Definition at line 34 of file RawReaderMemory.cxx.

◆ getFileSize()

int o2::emcal::RawReaderMemory::getFileSize ( ) const
inlinenoexcept

get the size of the file in bytes

Returns
size of the file in byte

Definition at line 139 of file RawReaderMemory.h.

◆ getMinorErrors()

gsl::span< const MinorError > o2::emcal::RawReaderMemory::getMinorErrors ( ) const
inline

Get minor (non-crashing) raw decoding errors.

Returns
Minor raw decoding errors

Definition at line 131 of file RawReaderMemory.h.

◆ getPayload()

const RawPayload & o2::emcal::RawReaderMemory::getPayload ( ) const
inline

access to the full raw payload (single or multiple DMA pages)

Returns
Raw Payload of the data until the stop bit is received.

Definition at line 127 of file RawReaderMemory.h.

◆ getPayloadSize()

int o2::emcal::RawReaderMemory::getPayloadSize ( ) const
inline

Return size of the payload.

Returns
size of the payload

Definition at line 135 of file RawReaderMemory.h.

◆ getRawBuffer()

const RawBuffer & RawReaderMemory::getRawBuffer ( ) const

access to the raw buffer (single DMA page)

Returns
Raw buffer of the current page
Exceptions
Errorwith PAYLOAD_INCALID if payload was not decoded

Definition at line 222 of file RawReaderMemory.cxx.

◆ getRawHeader()

const o2::header::RDHAny & RawReaderMemory::getRawHeader ( ) const

access to the raw header of the current page

Returns
Raw header of the current page
Exceptions
RawDecodingErrorwith HEADER_INVALID if the header was not decoded

Definition at line 214 of file RawReaderMemory.cxx.

◆ hasNext()

bool o2::emcal::RawReaderMemory::hasNext ( ) const
inline

check if more pages are available in the raw file

Returns
true if there is a next page

Definition at line 143 of file RawReaderMemory.h.

◆ init()

void RawReaderMemory::init ( )
protected

Initialize the raw stream.

Rewind stream to the first entry

Definition at line 53 of file RawReaderMemory.cxx.

◆ next()

void RawReaderMemory::next ( )

Read next payload from the stream.

Read the next pages until the stop bit is found.

eventually in the future check continuing payload based on the bc/orbit ID auto currentbc = RDHDecoder::getTriggerBC(mRawHeader), nextbc = RDHDecoder::getTriggerBC(nextheader); auto currentorbit = RDHDecoder::getTriggerOrbit(mRawHeader), nextorbit = RDHDecoder::getTriggerOrbit(nextheader);

Definition at line 61 of file RawReaderMemory.cxx.

◆ nextPage()

void RawReaderMemory::nextPage ( bool  resetPayload = true)

Read the next page from the stream (single DMA page)

Parameters
resetPayloadIf true the raw payload is reset
Exceptions
Errorif the page cannot be read or header or payload cannot be deocded

Function reading a single DMA page from the stream. It is called inside the next() function for reading payload from multiple DMA pages. As the function cannot handle payload from multiple pages it should not be called directly by the user.

Assume fixed 8 kB page size

Definition at line 95 of file RawReaderMemory.cxx.

◆ setRangeSRUDDLs()

void o2::emcal::RawReaderMemory::setRangeSRUDDLs ( uint16_t  minDDL,
uint16_t  maxDDL 
)
inline

Set range for DDLs from SRU (for RCU trailer merging)

Parameters
minDDLMin DDL of the SRU DDL range
maxDDLMax DDL of the SRU DDL range

Definition at line 94 of file RawReaderMemory.h.

◆ setRawMemory()

void RawReaderMemory::setRawMemory ( const gsl::span< const char >  rawmemory)

set new raw memory chunk

Parameters
rawmemoryNew raw memory chunk

Definition at line 28 of file RawReaderMemory.cxx.

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