tdaq-develop-2025-02-12
ots::UDPFragmentWriter Class Reference
Inheritance diagram for ots::UDPFragmentWriter:
ots::UDPFragment

Public Member Functions

 UDPFragmentWriter (artdaq::Fragment &f)
 
uint8_t * dataBegin ()
 
uint8_t * dataEnd ()
 
Headerheader_ ()
 
void set_hdr_type (Header::data_type_t dataType)
 
void resize (size_t nBytes)
 
- Public Member Functions inherited from ots::UDPFragment
 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from ots::UDPFragment
static constexpr size_t hdr_size_words ()
 
- Protected Member Functions inherited from ots::UDPFragment
Header const * header_ () const
 
- Static Protected Member Functions inherited from ots::UDPFragment
static constexpr size_t bytes_per_word_ ()
 

Detailed Description

Definition at line 27 of file UDPFragmentWriter.hh.

Constructor & Destructor Documentation

◆ UDPFragmentWriter()

ots::UDPFragmentWriter::UDPFragmentWriter ( artdaq::Fragment &  f)

The constructor will expect the artdaq::Fragment object it's been passed to contain the artdaq::Fragment header + the UDPFragment::Metadata object, otherwise it throws

Allocate space for the header

Definition at line 64 of file UDPFragmentWriter.hh.

Member Function Documentation

◆ dataBegin()

uint8_t * ots::UDPFragmentWriter::dataBegin ( )
inline

These functions form overload sets with const functions from ots::UDPFragment

Make sure there's data past the UDPFragment header

Definition at line 78 of file UDPFragmentWriter.hh.

◆ header_()

Header* ots::UDPFragmentWriter::header_ ( )
inline

We'll need to hide the const version of header in UDPFragment in order to be able to perform writes

Definition at line 41 of file UDPFragmentWriter.hh.


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