DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
dunedaq::daqdataformats::TriggerRecordHeaderData Struct Reference

Additional data fields associated with a TriggerRecordHeader. More...

#include <TriggerRecordHeaderData.hpp>

Collaboration diagram for dunedaq::daqdataformats::TriggerRecordHeaderData:
[legend]

Public Attributes

uint32_t trigger_record_header_marker = s_trigger_record_header_magic
 Magic bytes used to identify a TriggerRecordHeaderData struct in a raw data stream.
 
uint32_t version = s_trigger_record_header_version
 Version of the TriggerRecordHeaderData structure.
 
trigger_number_t trigger_number { TypeDefaults::s_invalid_trigger_number }
 Trigger Number.
 
timestamp_t trigger_timestamp { TypeDefaults::s_invalid_timestamp }
 Timestamp of the TriggerDecision.
 
uint64_t num_requested_components { s_invalid_number_components }
 Number of ComponentRequest objects stored in the TriggerRecordHeader.
 
run_number_t run_number { TypeDefaults::s_invalid_run_number }
 Run Number for the TriggerRecord.
 
uint32_t error_bits { s_default_error_bits }
 Error bits for the TriggerRecord.
 
trigger_type_t trigger_type { TypeDefaults::s_invalid_trigger_type }
 Type of the TriggerDecision.
 
sequence_number_t sequence_number { TypeDefaults::s_invalid_sequence_number }
 Sequence number of this TriggerRecord within the trigger response.
 
sequence_number_t max_sequence_number { TypeDefaults::s_invalid_sequence_number }
 Maximum sequence number of TriggerRecords corresponding to this trigger.
 
uint32_t unused { 0xFFFFFFFF }
 Padding to ensure 64-bit alignment.
 
SourceID element_id
 

Static Public Attributes

static constexpr uint32_t s_trigger_record_header_magic = 0x33334444
 Magic bytes to identify a TriggerRecordHeader entry in a raw data stream.
 
static constexpr uint32_t s_trigger_record_header_version = 4
 The current version of the TriggerRecordHeader.
 
static constexpr uint64_t s_invalid_number_components
 An invalid number of components.
 
static constexpr uint32_t s_default_error_bits = 0
 By default, all error bits are unset.
 

Detailed Description

Additional data fields associated with a TriggerRecordHeader.

Definition at line 27 of file TriggerRecordHeaderData.hpp.

Member Data Documentation

◆ element_id

SourceID dunedaq::daqdataformats::TriggerRecordHeaderData::element_id

Definition at line 104 of file TriggerRecordHeaderData.hpp.

◆ error_bits

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

Error bits for the TriggerRecord.

Definition at line 83 of file TriggerRecordHeaderData.hpp.

83{ s_default_error_bits }; // NOLINT(build/unsigned)
static constexpr uint32_t s_default_error_bits
By default, all error bits are unset.

◆ max_sequence_number

sequence_number_t dunedaq::daqdataformats::TriggerRecordHeaderData::max_sequence_number { TypeDefaults::s_invalid_sequence_number }

Maximum sequence number of TriggerRecords corresponding to this trigger.

Definition at line 97 of file TriggerRecordHeaderData.hpp.

static constexpr sequence_number_t s_invalid_sequence_number
Definition Types.hpp:71

◆ num_requested_components

uint64_t dunedaq::daqdataformats::TriggerRecordHeaderData::num_requested_components { s_invalid_number_components }

Number of ComponentRequest objects stored in the TriggerRecordHeader.

Definition at line 73 of file TriggerRecordHeaderData.hpp.

73{ s_invalid_number_components }; // NOLINT(build/unsigned)
static constexpr uint64_t s_invalid_number_components
An invalid number of components.

◆ run_number

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

Run Number for the TriggerRecord.

Definition at line 78 of file TriggerRecordHeaderData.hpp.

static constexpr run_number_t s_invalid_run_number
An invalid run number.
Definition Types.hpp:57

◆ s_default_error_bits

uint32_t dunedaq::daqdataformats::TriggerRecordHeaderData::s_default_error_bits = 0
staticconstexpr

By default, all error bits are unset.

Definition at line 48 of file TriggerRecordHeaderData.hpp.

◆ s_invalid_number_components

uint64_t dunedaq::daqdataformats::TriggerRecordHeaderData::s_invalid_number_components
staticconstexpr
Initial value:
=
std::numeric_limits<uint64_t>::max()

An invalid number of components.

Definition at line 42 of file TriggerRecordHeaderData.hpp.

◆ s_trigger_record_header_magic

uint32_t dunedaq::daqdataformats::TriggerRecordHeaderData::s_trigger_record_header_magic = 0x33334444
staticconstexpr

Magic bytes to identify a TriggerRecordHeader entry in a raw data stream.

Definition at line 32 of file TriggerRecordHeaderData.hpp.

◆ s_trigger_record_header_version

uint32_t dunedaq::daqdataformats::TriggerRecordHeaderData::s_trigger_record_header_version = 4
staticconstexpr

The current version of the TriggerRecordHeader.

Definition at line 37 of file TriggerRecordHeaderData.hpp.

◆ sequence_number

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

Sequence number of this TriggerRecord within the trigger response.

Definition at line 93 of file TriggerRecordHeaderData.hpp.

◆ trigger_number

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

Trigger Number.

Definition at line 63 of file TriggerRecordHeaderData.hpp.

static constexpr trigger_number_t s_invalid_trigger_number
An invalid trigger number.
Definition Types.hpp:59

◆ trigger_record_header_marker

uint32_t dunedaq::daqdataformats::TriggerRecordHeaderData::trigger_record_header_marker = s_trigger_record_header_magic

Magic bytes used to identify a TriggerRecordHeaderData struct in a raw data stream.

Definition at line 53 of file TriggerRecordHeaderData.hpp.

◆ trigger_timestamp

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

Timestamp of the TriggerDecision.

Definition at line 68 of file TriggerRecordHeaderData.hpp.

static constexpr timestamp_t s_invalid_timestamp
An invalid timestamp.
Definition Types.hpp:65

◆ trigger_type

trigger_type_t dunedaq::daqdataformats::TriggerRecordHeaderData::trigger_type { TypeDefaults::s_invalid_trigger_type }

Type of the TriggerDecision.

Definition at line 88 of file TriggerRecordHeaderData.hpp.

static constexpr trigger_type_t s_invalid_trigger_type
An invalid trigger type.
Definition Types.hpp:69

◆ unused

uint32_t dunedaq::daqdataformats::TriggerRecordHeaderData::unused { 0xFFFFFFFF }

Padding to ensure 64-bit alignment.

Definition at line 102 of file TriggerRecordHeaderData.hpp.

102{ 0xFFFFFFFF }; // NOLINT(build/unsigned)

◆ version

uint32_t dunedaq::daqdataformats::TriggerRecordHeaderData::version = s_trigger_record_header_version

Version of the TriggerRecordHeaderData structure.

Definition at line 58 of file TriggerRecordHeaderData.hpp.


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