tdaq-develop-2025-02-12
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
ots::UDPFragment Class Reference
Inheritance diagram for ots::UDPFragment:
ots::UDPFragmentWriter

Classes

struct  Header
 
struct  Metadata
 

Public Member Functions

 UDPFragment (artdaq::Fragment const &f)
 
Header::event_size_t hdr_event_size () const
 
Header::data_type_t hdr_data_type () const
 
size_t udp_data_words () const
 UDP Data Word Count.
 
uint8_t const * dataBegin () const
 Start of the UDP data, returned as a pointer.
 
uint8_t const * dataEnd () const
 End of the UDP data, returned as a pointer.
 

Static Public Member Functions

static constexpr size_t hdr_size_words ()
 

Protected Member Functions

Header const * header_ () const
 

Static Protected Member Functions

static constexpr size_t bytes_per_word_ ()
 

Detailed Description

Definition at line 20 of file UDPFragment.hh.

Constructor & Destructor Documentation

◆ UDPFragment()

ots::UDPFragment::UDPFragment ( artdaq::Fragment const &  f)
inline

The constructor simply sets its const private member "artdaq_Fragment_" to refer to the artdaq::Fragment object

Definition at line 79 of file UDPFragment.hh.

Member Function Documentation

◆ bytes_per_word_()

static constexpr size_t ots::UDPFragment::bytes_per_word_ ( )
inlinestaticconstexprprotected

Functions to translate between byte size and the size of this fragment overlay's concept of a unit of data (i.e., Header::data_t).

Definition at line 107 of file UDPFragment.hh.

◆ hdr_event_size()

Header::event_size_t ots::UDPFragment::hdr_event_size ( ) const
inline

const getter functions for the data in the header

Definition at line 83 of file UDPFragment.hh.

◆ header_()

Header const* ots::UDPFragment::header_ ( ) const
inlineprotected

header_() simply takes the address of the start of this overlay's data (i.e., where the UDPFragment::Header object begins) and casts it as a pointer to UDPFragment::Header

Definition at line 116 of file UDPFragment.hh.

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