LDMX Software
LDMXRoRHeader.h
1#pragma once
2#ifndef PACKING_LDMXRORHEADER_H
3#define PACKING_LDMXRORHEADER_H
4
5#include <cstdint>
6#include <unordered_map>
7
8#include "Packing/Utility/Reader.h"
9
10namespace packing {
11
22 public:
24 static const unsigned int SIZE = 16;
34 static const std::unordered_map<std::string, int> SUBSYSTEM_ID;
35
48 static const std::unordered_map<std::string, int> CONTRIBUTOR_ID;
49
62 static std::tuple<int, int> subsystem(const std::string& name);
63
79 static std::string getSubsystemName(uint8_t subsystem_id,
80 uint8_t contributor_id);
81
86 bool valid() const { return valid_; }
96 uint32_t flags() const { return flags_; }
98 static constexpr uint32_t FLAG_DATA_DROPPED{0x1};
100 bool dataDropped() const { return flags_ & FLAG_DATA_DROPPED; }
102 uint8_t lostBefore() const { return (flags_ >> 8) & 0xff; }
104 uint8_t version() const { return version_; }
106 uint8_t subsystem() const { return subsystem_; }
108 uint8_t contributor() const { return contributor_; }
110 uint64_t timestamp() const { return timestamp_; }
111
112 private:
114 bool valid_{false};
116 uint8_t version_;
118 uint8_t subsystem_;
122 uint32_t flags_{0};
124 static constexpr uint32_t FLAG_MASK{0xff07};
132 uint64_t timestamp_;
133};
134
135} // namespace packing
136
137#endif
the header that the LDMX DAQ Firmware block includes in the output data stream at the beginning of ea...
uint64_t timestamp_
timestamp of this Readout-Request (RoR)
uint8_t subsystem() const
ID number for subsystem originating data (compiled into firmware)
static constexpr uint32_t FLAG_MASK
flag bits in use, the others must be zero
bool valid_
set to true only when all validity checks pass during read()
static constexpr uint32_t FLAG_DATA_DROPPED
header-only fragment, see flags()
uint8_t contributor() const
ID number for contributor within subsystem (configured into firmware)
static std::string getSubsystemName(uint8_t subsystem_id, uint8_t contributor_id)
Get the subsystem name from subsystem and contributor IDs.
uint8_t version() const
version of LDMX data (should be zero)
uint8_t lostBefore() const
number of readout requests lost before this one, saturates at 255
bool valid() const
true if the header was parsed successfully (sentinel matched and the unused flag bits are zero)
uint32_t flags() const
flags set by the DAQ event formatter
uint8_t contributor_
ID number for contributor within subsystem (configured into firmware)
uint32_t flags_
formatter flags, see flags()
static const std::unordered_map< std::string, int > SUBSYSTEM_ID
The subsystem ID numbers organized by subsystem name.
uint64_t timestamp() const
get timestamp of this RoR
uint8_t version_
version of LDMX data (should be zero)
utility::Reader & read(utility::Reader &r)
read the next LDMX RoR header into memory
uint8_t subsystem_
ID number for subsystem originating data (compiled into firmware)
static const std::unordered_map< std::string, int > CONTRIBUTOR_ID
The contributor ID is a configurable parameter of the DAQ firmware.
bool dataDropped() const
true if the formatter dropped this fragment's data (header only)
static const unsigned int SIZE
size of this header in bytes
Reading a raw data file.
Definition Reader.h:20