TriggerRecordHeaderData.hpp

Go to the documentation of this file.

 
#ifndef DAQDATAFORMATS_INCLUDE_DAQDATAFORMATS_TRIGGERRECORDHEADERDATA_HPP_
#define DAQDATAFORMATS_INCLUDE_DAQDATAFORMATS_TRIGGERRECORDHEADERDATA_HPP_
 
#include "daqdataformats/ComponentRequest.hpp"
#include "daqdataformats/SourceID.hpp"
#include "daqdataformats/Types.hpp"
 
#include <cstddef>
#include <limits>
#include <ostream>
#include <string>
#include <vector>
 
namespace dunedaq::daqdataformats {
 
struct TriggerRecordHeaderData
{
  static constexpr uint32_t s_trigger_record_header_magic = 0x33334444; // NOLINT(build/unsigned)
 
  static constexpr uint32_t s_trigger_record_header_version = 5; // NOLINT(build/unsigned)
 
  static constexpr uint64_t s_invalid_number_components = // NOLINT(build/unsigned)
    std::numeric_limits<uint64_t>::max();                 // NOLINT(build/unsigned)
 
  static constexpr uint32_t s_default_status_bits = 0; // NOLINT(build/unsigned)
 
  uint32_t trigger_record_header_marker = s_trigger_record_header_magic; // NOLINT(build/unsigned)
 
  uint32_t version = s_trigger_record_header_version; // NOLINT(build/unsigned)
 
  trigger_number_t trigger_number{ TypeDefaults::s_invalid_trigger_number };
 
  timestamp_t trigger_timestamp{ TypeDefaults::s_invalid_timestamp };
 
  uint64_t num_requested_components{ s_invalid_number_components }; // NOLINT(build/unsigned)
 
  run_number_t run_number{ TypeDefaults::s_invalid_run_number };
 
  uint32_t status_bits{ s_default_status_bits }; // NOLINT(build/unsigned)
 
  trigger_type_t trigger_type{ TypeDefaults::s_invalid_trigger_type };
 
  sequence_number_t sequence_number{ TypeDefaults::s_invalid_sequence_number };
  sequence_number_t max_sequence_number{ TypeDefaults::s_invalid_sequence_number };
 
  uint32_t unused{ 0xFFFFFFFF }; // NOLINT(build/unsigned)
 
  SourceID element_id;
};
 
static_assert(TriggerRecordHeaderData::s_trigger_record_header_version == 5,
              "This is intentionally designed to tell the developer to update the static_assert checks (including this "
              "one) when the version is bumped");
 
static_assert(sizeof(TriggerRecordHeaderData) == 64, "TriggerRecordHeaderData struct size different than expected!");
static_assert(offsetof(TriggerRecordHeaderData, trigger_record_header_marker) == 0,
              "TriggerRecordHeaderData trigger_record_header_marker field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, version) == 4,
              "TriggerRecordHeaderData version field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, trigger_number) == 8,
              "TriggerRecordHeaderData trigger_number field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, trigger_timestamp) == 16,
              "TriggerRecordHeaderData trigger_timestamp field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, num_requested_components) == 24,
              "TriggerRecordHeaderData num_requested_components field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, run_number) == 32,
              "TriggerRecordHeaderData run_number field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, status_bits) == 36,
              "TriggerRecordHeaderData status_bits field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, trigger_type) == 40,
              "TriggerRecordHeaderData trigger_type field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, sequence_number) == 48,
              "TriggerRecordHeaderData sequence_number field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, max_sequence_number) == 50,
              "TriggerRecordHeaderData max_sequence_number field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, unused) == 52,
              "TriggerRecordHeaderData unused field not at expected offset!");
static_assert(offsetof(TriggerRecordHeaderData, element_id) == 56,
              "TriggerRecordHeaderData source_id field not at expected offset!");
 
enum class TriggerRecordStatusBits : size_t
{
  kIncomplete = 0,    
  kMismatch = 1,      
  kUnassigned2 = 2,   
  kUnassigned3 = 3,   
  kUnassigned4 = 4,   
  kUnassigned5 = 5,   
  kUnassigned6 = 6,   
  kUnassigned7 = 7,   
  kUnassigned8 = 8,   
  kUnassigned9 = 9,   
  kUnassigned10 = 10, 
  kUnassigned11 = 11, 
  kUnassigned12 = 12, 
  kUnassigned13 = 13, 
  kUnassigned14 = 14, 
  kUnassigned15 = 15, 
  kUnassigned16 = 16, 
  kUnassigned17 = 17, 
  kUnassigned18 = 18, 
  kUnassigned19 = 19, 
  kUnassigned20 = 20, 
  kUnassigned21 = 21, 
  kUnassigned22 = 22, 
  kUnassigned23 = 23, 
  kUnassigned24 = 24, 
  kUnassigned25 = 25, 
  kUnassigned26 = 26, 
  kUnassigned27 = 27, 
  kUnassigned28 = 28, 
  kUnassigned29 = 29, 
  kUnassigned30 = 30, 
  kUnassigned31 = 31, 
  kInvalid = 32       
};
 
inline std::ostream&
operator<<(std::ostream& o, TriggerRecordHeaderData const& hdr)
{
  return o << "check_word: " << std::hex << hdr.trigger_record_header_marker << std::dec << ", "
           << "version: " << hdr.version << ", "
 
           << "trigger_number: " << hdr.trigger_number << ", " << "run_number: " << hdr.run_number << ", "
           << "trigger_timestamp: " << hdr.trigger_timestamp << ", " << "trigger_type: " << hdr.trigger_type << ", "
 
           << "status_bits: " << hdr.status_bits << ", "
 
           << "num_requested_components: " << hdr.num_requested_components << ", "
           << "sequence_number: " << hdr.sequence_number << ", " << "max_sequence_number: " << hdr.max_sequence_number
           << ", " << "element_id: { " << hdr.element_id << " }";
}
 
inline std::istream&
operator>>(std::istream& o, TriggerRecordHeaderData& hdr)
{
  std::string tmp;
  return o >> tmp >> std::hex >> hdr.trigger_record_header_marker >> std::dec >> tmp >> tmp >> hdr.version >> tmp >>
         tmp >> hdr.trigger_number >> tmp >> tmp >> hdr.run_number >> tmp >> tmp >> hdr.trigger_timestamp >> tmp >>
         tmp >> hdr.trigger_type >> tmp >> tmp >> hdr.status_bits >> tmp >> tmp >> hdr.num_requested_components >>
         tmp >> tmp >> hdr.sequence_number >> tmp >> tmp >> hdr.max_sequence_number >> tmp >> tmp >> tmp >>
         hdr.element_id;
}
 
} // namespace dunedaq::daqdataformats
 
#endif // DAQDATAFORMATS_INCLUDE_DAQDATAFORMATS_TRIGGERRECORDHEADERDATA_HPP_