artdaq::FragmentStoreElement Class Reference

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

#include <proto/FragmentReceiverManager.hh>

List of all members.

Public Member Functions

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

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 126 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:
frag Fragment to add

Definition at line 164 of file FragmentReceiverManager.hh.

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

Add a Fragment to the front of the FragmentStoreElement.

Parameters:
frag Fragment to add

Definition at line 153 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 144 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 175 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 193 of file FragmentReceiverManager.hh.

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

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

Parameters:
eod Number of Receives expected for this receiver

Definition at line 188 of file FragmentReceiverManager.hh.


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

Generated on 19 Feb 2018 for artdaq by  doxygen 1.6.1