dunedaq::daqdataformats::FragmentHeader Struct Reference

The header for a DUNE Fragment. More...

#include <FragmentHeader.hpp>

Collaboration diagram for dunedaq::daqdataformats::FragmentHeader:

Public Attributes
uint32_t	fragment_header_marker = s_fragment_header_marker
	Marker Bytes used to identify FragmentHeaders in a raw data stream.
uint32_t	version = s_fragment_header_version
	Version of the FragmentHeader.
fragment_size_t	size { TypeDefaults::s_invalid_fragment_size }
	Size of the Fragment (including header and payload)
trigger_number_t	trigger_number { TypeDefaults::s_invalid_trigger_number }
	Trigger Number this Fragment is associated with.
timestamp_t	trigger_timestamp { TypeDefaults::s_invalid_timestamp }
	Timestamp of the TriggerDecision.
timestamp_t	window_begin { TypeDefaults::s_invalid_timestamp }
	Window begin of data in the Fragment.
timestamp_t	window_end { TypeDefaults::s_invalid_timestamp }
	Window end of data in the Fragment.
run_number_t	run_number { TypeDefaults::s_invalid_run_number }
	Run number this Fragment is associated with.
uint32_t	error_bits { s_default_error_bits }
	Error bits set by the Upstream DAQ.
fragment_type_t	fragment_type { TypeDefaults::s_invalid_fragment_type }
	Type of the Fragment, indicating the format of the contained payload.
sequence_number_t	sequence_number { TypeDefaults::s_invalid_sequence_number }
	Sequence number of this Fragment within a trigger record.
uint16_t	detector_id
	Identifier for the subdetector that produced the raw data in the Fragment payload.
SourceID	element_id
	Component that generated the data in this Fragment.

Static Public Attributes
static constexpr uint32_t	s_fragment_header_marker = 0x11112222
	Marker bytes to identify a FragmentHeader entry in a raw data stream.
static constexpr uint32_t	s_fragment_header_version = 5
	The current version of the Fragment.
static constexpr uint32_t	s_default_error_bits = 0
	By default, all error bits are unset.

Detailed Description

The header for a DUNE Fragment.

Definition at line 28 of file FragmentHeader.hpp.

Member Data Documentation

detector_id

uint16_t dunedaq::daqdataformats::FragmentHeader::detector_id

Identifier for the subdetector that produced the raw data in the Fragment payload.

Definition at line 106 of file FragmentHeader.hpp.

element_id

SourceID dunedaq::daqdataformats::FragmentHeader::element_id

Component that generated the data in this Fragment.

Definition at line 111 of file FragmentHeader.hpp.

error_bits

uint32_t dunedaq::daqdataformats::FragmentHeader::error_bits { s_default_error_bits }

Error bits set by the Upstream DAQ.

Defined Error bits should be documented here, along with the Fragment Type(s) that they apply to

Definition at line 90 of file FragmentHeader.hpp.

{ s_default_error_bits }; // NOLINT(build/unsigned)

fragment_header_marker

uint32_t dunedaq::daqdataformats::FragmentHeader::fragment_header_marker = s_fragment_header_marker

Marker Bytes used to identify FragmentHeaders in a raw data stream.

Definition at line 48 of file FragmentHeader.hpp.

fragment_type

fragment_type_t dunedaq::daqdataformats::FragmentHeader::fragment_type { TypeDefaults::s_invalid_fragment_type }

Type of the Fragment, indicating the format of the contained payload.

Definition at line 95 of file FragmentHeader.hpp.

{ TypeDefaults::s_invalid_fragment_type };

run_number

run_number_t dunedaq::daqdataformats::FragmentHeader::run_number { TypeDefaults::s_invalid_run_number }

Run number this Fragment is associated with.

Definition at line 83 of file FragmentHeader.hpp.

{ TypeDefaults::s_invalid_run_number };

s_default_error_bits

uint32_t dunedaq::daqdataformats::FragmentHeader::s_default_error_bits = 0

staticconstexpr

By default, all error bits are unset.

Definition at line 43 of file FragmentHeader.hpp.

s_fragment_header_marker

uint32_t dunedaq::daqdataformats::FragmentHeader::s_fragment_header_marker = 0x11112222

staticconstexpr

Marker bytes to identify a FragmentHeader entry in a raw data stream.

Definition at line 33 of file FragmentHeader.hpp.

s_fragment_header_version

uint32_t dunedaq::daqdataformats::FragmentHeader::s_fragment_header_version = 5

staticconstexpr

The current version of the Fragment.

Definition at line 38 of file FragmentHeader.hpp.

sequence_number

sequence_number_t dunedaq::daqdataformats::FragmentHeader::sequence_number { TypeDefaults::s_invalid_sequence_number }

Sequence number of this Fragment within a trigger record.

Definition at line 100 of file FragmentHeader.hpp.

{ TypeDefaults::s_invalid_sequence_number };

size

fragment_size_t dunedaq::daqdataformats::FragmentHeader::size { TypeDefaults::s_invalid_fragment_size }

Size of the Fragment (including header and payload)

Definition at line 58 of file FragmentHeader.hpp.

{ TypeDefaults::s_invalid_fragment_size }; // NOLINT(build/unsigned)

trigger_number

trigger_number_t dunedaq::daqdataformats::FragmentHeader::trigger_number { TypeDefaults::s_invalid_trigger_number }

Trigger Number this Fragment is associated with.

Definition at line 63 of file FragmentHeader.hpp.

{ TypeDefaults::s_invalid_trigger_number };

trigger_timestamp

timestamp_t dunedaq::daqdataformats::FragmentHeader::trigger_timestamp { TypeDefaults::s_invalid_timestamp }

Timestamp of the TriggerDecision.

Definition at line 68 of file FragmentHeader.hpp.

{ TypeDefaults::s_invalid_timestamp };

version

uint32_t dunedaq::daqdataformats::FragmentHeader::version = s_fragment_header_version

Version of the FragmentHeader.

Definition at line 53 of file FragmentHeader.hpp.

window_begin

timestamp_t dunedaq::daqdataformats::FragmentHeader::window_begin { TypeDefaults::s_invalid_timestamp }

Window begin of data in the Fragment.

Definition at line 73 of file FragmentHeader.hpp.

{ TypeDefaults::s_invalid_timestamp };

window_end

timestamp_t dunedaq::daqdataformats::FragmentHeader::window_end { TypeDefaults::s_invalid_timestamp }

Window end of data in the Fragment.

Definition at line 78 of file FragmentHeader.hpp.

{ TypeDefaults::s_invalid_timestamp };

---

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

• /github/workspace/dunedaq/sourcecode/daqdataformats/include/daqdataformats/FragmentHeader.hpp