artdaq  v3_08_00
artdaq::FragmentStoreElement Class Reference

This class contains tracking information for all Fragment objects which have been received from a specific source. More...

#include <artdaq/DAQrate/FragmentReceiverManager.hh>

Public Member Functions

 FragmentStoreElement ()
 FragmentStoreElement Constructor.
 
bool empty () const
 Are any Fragment objects contained in this FragmentStoreElement? More...
 
void emplace_front (FragmentPtr &&frag)
 Add a Fragment to the front of the FragmentStoreElement. More...
 
void emplace_back (FragmentPtr &&frag)
 Add a Fragment to the end of the FragmentStoreElement. More...
 
FragmentPtr front ()
 Remove the first Fragment from the FragmentStoreElement and return it. More...
 
void SetEndOfData (size_t eod)
 Set the End-Of-Data marker value for this Receiver. More...
 
size_t GetEndOfData () const
 Get the value of the End-Of-Data marker for this Receiver. More...
 
size_t size () const
 Get the number of Fragments stored in this FragmentStoreElement. More...
 

Detailed Description

This class contains tracking information for all Fragment objects which have been received from a specific source.

This class was designed so that there could be a mutex for each source, instead of locking all sources whenever a Fragment had to be retrieved. FragmentStoreElement is itself a container type, sorted by Fragment arrival time. It is a modified queue, with only the first element accessible, but it allows elements to be added to either end (for rejected Fragments).

Definition at line 134 of file FragmentReceiverManager.hh.

Member Function Documentation

void artdaq::FragmentStoreElement::emplace_back ( FragmentPtr &&  frag)
inline

Add a Fragment to the end of the FragmentStoreElement.

Parameters
fragFragment to add

Definition at line 172 of file FragmentReceiverManager.hh.

void artdaq::FragmentStoreElement::emplace_front ( FragmentPtr &&  frag)
inline

Add a Fragment to the front of the FragmentStoreElement.

Parameters
fragFragment to add

Definition at line 161 of file FragmentReceiverManager.hh.

bool artdaq::FragmentStoreElement::empty ( ) const
inline

Are any Fragment objects contained in this FragmentStoreElement?

Returns
Whether any Fragment objects are contained in this FragmentStoreElement

Definition at line 152 of file FragmentReceiverManager.hh.

FragmentPtr artdaq::FragmentStoreElement::front ( )
inline

Remove the first Fragment from the FragmentStoreElement and return it.

Returns
The first Fragment in the FragmentStoreElement

Definition at line 183 of file FragmentReceiverManager.hh.

size_t artdaq::FragmentStoreElement::GetEndOfData ( ) const
inline

Get the value of the End-Of-Data marker for this Receiver.

Returns
The value of the End-Of-Data marker. Returns -1 (0xFFFFFFFFFFFFFFFF) if no EndOfData Fragments received

Definition at line 201 of file FragmentReceiverManager.hh.

void artdaq::FragmentStoreElement::SetEndOfData ( size_t  eod)
inline

Set the End-Of-Data marker value for this Receiver.

Parameters
eodNumber of Receives expected for this receiver

Definition at line 196 of file FragmentReceiverManager.hh.

size_t artdaq::FragmentStoreElement::size ( ) const
inline

Get the number of Fragments stored in this FragmentStoreElement.

Returns
The number of Fragments stored in this FragmentStoreElement

Definition at line 207 of file FragmentReceiverManager.hh.


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