DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
trigger_record.cpp
Go to the documentation of this file.
1
11
12#include <pybind11/pybind11.h>
13#include <pybind11/stl.h>
14
15#include <memory>
16#include <vector>
17
18namespace py = pybind11;
19
21
22void
24{
25 py::class_<TriggerRecordHeader>(m, "TriggerRecordHeader", pybind11::buffer_protocol())
26 .def(py::init<std::vector<ComponentRequest> const&>())
27 .def(py::init([](py::capsule capsule, bool copy_from_buffer) {
28 return std::make_unique<TriggerRecordHeader>(capsule.get_pointer(), copy_from_buffer);
29 }))
30 .def(py::init<TriggerRecordHeader const&>())
31 .def("get_header", &TriggerRecordHeader::get_header)
32 .def("get_trigger_number", &TriggerRecordHeader::get_trigger_number)
33 //.def("set_trigger_number", &TriggerRecordHeader::set_trigger_number)
34 .def("get_trigger_timestamp", &TriggerRecordHeader::get_trigger_timestamp)
35 //.def("set_trigger_timestamp", &TriggerRecordHeader::set_trigger_timestamp)
36 .def("get_num_requested_components", &TriggerRecordHeader::get_num_requested_components)
37 .def("get_run_number", &TriggerRecordHeader::get_run_number)
38 //.def("set_run_number", &TriggerRecordHeader::set_run_number)
39 .def("get_status_bits", &TriggerRecordHeader::get_status_bits)
40 //.def("set_status_bits", &TriggerRecordHeader::set_status_bits)
41 .def("get_status_bit", &TriggerRecordHeader::get_status_bit)
42 //.def("set_status_bit", &TriggerRecordHeader::set_status_bit)
43 .def("get_trigger_type", &TriggerRecordHeader::get_trigger_type)
44 //.def("set_trigger_type", &TriggerRecordHeader::set_trigger_type)
45 .def("get_sequence_number", &TriggerRecordHeader::get_sequence_number)
46 //.def("set_sequence_number", &TriggerRecordHeader::set_sequence_number)
47 .def("get_max_sequence_number", &TriggerRecordHeader::get_max_sequence_number)
48 //.def("set_max_sequence_number", &TriggerRecordHeader::set_max_sequence_number)
49 .def("get_total_size_bytes", &TriggerRecordHeader::get_total_size_bytes)
50 .def(
51 "get_storage_location", &TriggerRecordHeader::get_storage_location, py::return_value_policy::reference_internal)
52 .def("at", &TriggerRecordHeader::at)
53 .def("__getitem__", &TriggerRecordHeader::operator[], py::return_value_policy::reference_internal);
54
55 py::class_<TriggerRecordHeaderData>(m, "TriggerRecordHeaderData")
56 .def_property_readonly_static("s_trigger_record_header_magic",
57 [](const TriggerRecordHeaderData& self) -> uint32_t { // NOLINT(build/unsigned)
59 })
60 .def_property_readonly_static("s_trigger_record_header_version",
61 [](const TriggerRecordHeaderData& self) -> uint32_t { // NOLINT(build/unsigned)
63 })
64 .def_property_readonly_static("s_invalid_number_components",
65 [](const TriggerRecordHeaderData& self) -> uint64_t { // NOLINT(build/unsigned)
67 })
68 .def_property_readonly_static("s_default_status_bits",
69 [](const TriggerRecordHeaderData& self) -> uint32_t { // NOLINT(build/unsigned)
70 return self.s_default_status_bits;
71 })
72 .def_property_readonly("trigger_record_header_marker",
73 [](const TriggerRecordHeaderData& self) -> uint32_t { // NOLINT(build/unsigned)
75 })
76 .def_property_readonly(
77 "version", [](const TriggerRecordHeaderData& self) -> uint32_t { return self.version; }) // NOLINT(build/unsigned)
78 .def_property_readonly("trigger_number",
79 [](const TriggerRecordHeaderData& self) -> trigger_number_t { return self.trigger_number; })
80 .def_property_readonly("trigger_timestamp",
81 [](const TriggerRecordHeaderData& self) -> timestamp_t { return self.trigger_timestamp; })
82 .def_property_readonly("num_requested_components",
83 [](const TriggerRecordHeaderData& self) -> uint64_t { // NOLINT(build/unsigned)
84 return self.num_requested_components;
85 })
86 .def_property_readonly("run_number",
87 [](const TriggerRecordHeaderData& self) -> run_number_t { return self.run_number; })
88 .def_property_readonly(
89 "status_bits",
90 [](const TriggerRecordHeaderData& self) -> uint32_t { return self.status_bits; }) // NOLINT(build/unsigned)
91 .def_property_readonly("trigger_type",
92 [](const TriggerRecordHeaderData& self) -> trigger_type_t { return self.trigger_type; })
93 .def_property_readonly(
94 "sequence_number", [](const TriggerRecordHeaderData& self) -> sequence_number_t { return self.sequence_number; })
95 .def_property_readonly("max_sequence_number", [](const TriggerRecordHeaderData& self) -> sequence_number_t {
96 return self.max_sequence_number;
97 });
98
99 py::enum_<TriggerRecordStatusBits>(m, "TriggerRecordStatusBits")
100 .value("kIncomplete", TriggerRecordStatusBits::kIncomplete)
101 .value("kMismatch", TriggerRecordStatusBits::kMismatch)
102 .value("kUnassigned2", TriggerRecordStatusBits::kUnassigned2)
103 .value("kUnassigned3", TriggerRecordStatusBits::kUnassigned3)
104 .value("kUnassigned4", TriggerRecordStatusBits::kUnassigned4)
105 .value("kUnassigned5", TriggerRecordStatusBits::kUnassigned5)
106 .value("kUnassigned6", TriggerRecordStatusBits::kUnassigned6)
107 .value("kUnassigned7", TriggerRecordStatusBits::kUnassigned7)
108 .value("kUnassigned8", TriggerRecordStatusBits::kUnassigned8)
109 .value("kUnassigned9", TriggerRecordStatusBits::kUnassigned9)
110 .value("kUnassigned10", TriggerRecordStatusBits::kUnassigned10)
111 .value("kUnassigned11", TriggerRecordStatusBits::kUnassigned11)
112 .value("kUnassigned12", TriggerRecordStatusBits::kUnassigned12)
113 .value("kUnassigned13", TriggerRecordStatusBits::kUnassigned13)
114 .value("kUnassigned14", TriggerRecordStatusBits::kUnassigned14)
115 .value("kUnassigned15", TriggerRecordStatusBits::kUnassigned15)
116 .value("kUnassigned16", TriggerRecordStatusBits::kUnassigned16)
117 .value("kUnassigned17", TriggerRecordStatusBits::kUnassigned17)
118 .value("kUnassigned18", TriggerRecordStatusBits::kUnassigned18)
119 .value("kUnassigned19", TriggerRecordStatusBits::kUnassigned19)
120 .value("kUnassigned20", TriggerRecordStatusBits::kUnassigned20)
121 .value("kUnassigned21", TriggerRecordStatusBits::kUnassigned21)
122 .value("kUnassigned22", TriggerRecordStatusBits::kUnassigned22)
123 .value("kUnassigned23", TriggerRecordStatusBits::kUnassigned23)
124 .value("kUnassigned24", TriggerRecordStatusBits::kUnassigned24)
125 .value("kUnassigned25", TriggerRecordStatusBits::kUnassigned25)
126 .value("kUnassigned26", TriggerRecordStatusBits::kUnassigned26)
127 .value("kUnassigned27", TriggerRecordStatusBits::kUnassigned27)
128 .value("kUnassigned28", TriggerRecordStatusBits::kUnassigned28)
129 .value("kUnassigned29", TriggerRecordStatusBits::kUnassigned29)
130 .value("kUnassigned30", TriggerRecordStatusBits::kUnassigned30)
131 .value("kUnassigned31", TriggerRecordStatusBits::kUnassigned31)
132 .value("kInvalid", TriggerRecordStatusBits::kInvalid);
133
134 py::class_<TriggerRecord> py_trigger_record(m, "TriggerRecord", pybind11::buffer_protocol());
135 py_trigger_record.def(py::init<TriggerRecordHeader const&>())
136 .def(py::init<std::vector<ComponentRequest> const&>())
137 .def(
138 "get_header_ref",
139 [](TriggerRecord& self) { return self.get_header_ref(); },
140 py::return_value_policy::reference_internal)
141 // .def("set_header", &TriggerRecord::set_header)
142 .def("get_header_data", &TriggerRecord::get_header_data)
143 .def(
144 "get_fragments_ref",
145 [](TriggerRecord& self) {
146 auto fragments = py::list();
147 for (auto& fragment : self.get_fragments_ref()) {
148 auto py_fragment = py::cast(*fragment, py::return_value_policy::reference);
149 fragments.append(py_fragment);
150 }
151 return fragments;
152 },
153 py::return_value_policy::reference_internal)
154 .def("get_total_size_bytes", &TriggerRecord::get_total_size_bytes)
155 .def("get_sum_of_fragment_payload_sizes", &TriggerRecord::get_sum_of_fragment_payload_sizes);
156} // NOLINT
157
158} // namespace dunedaq::daqdataformats::python
uint64_t get_num_requested_components() const
Get the number of ComponentRequest objects stored in this TriggerRecordHeader.
size_t get_total_size_bytes() const
Get the total size of the TriggerRecordHeader.
const void * get_storage_location() const
Get the location of the flat data array for output.
trigger_number_t get_max_sequence_number() const
Get the maximum sequence number for this TriggerRecordHeader.
trigger_type_t get_trigger_type() const
Get the trigger_type field from the data struct.
run_number_t get_run_number() const
Get the run_number stored in this TriggerRecordHeader.
ComponentRequest at(size_t idx) const
Access ComponentRequest and copy result.
TriggerRecordHeaderData get_header() const
Get a copy of the TriggerRecordHeaderData struct.
timestamp_t get_trigger_timestamp() const
Get the trigger_timestamp stored in this TriggerRecordHeader.
std::bitset< 32 > get_status_bits() const
Get the status_bits header field as a bitset.
trigger_number_t get_trigger_number() const
Get the trigger number for this TriggerRecordHeader.
trigger_number_t get_sequence_number() const
Get the sequence number for this TriggerRecordHeader.
bool get_status_bit(TriggerRecordStatusBits bit) const
Get the value of the given status bit.
C++ Representation of a DUNE TriggerRecord, consisting of a TriggerRecordHeader object and a vector o...
TriggerRecordHeaderData get_header_data() const
Get a copy of the TriggerRecordHeaderData from the TriggerRecordHeader.
size_t get_total_size_bytes() const
Get size of trigger record from underlying TriggerRecordHeader and Fragments.
size_t get_sum_of_fragment_payload_sizes() const
Get the sum of the fragment payload sizes.
void register_trigger_record(py::module &)
uint32_t run_number_t
Type used to represent run number.
Definition Types.hpp:20
uint64_t trigger_number_t
Type used to represent trigger number.
Definition Types.hpp:24
@ kUnassigned20
Status bit 20 is not assigned.
@ kUnassigned13
Status bit 13 is not assigned.
@ kUnassigned26
Status bit 26 is not assigned.
@ kUnassigned6
Status bit 6 is not assigned.
@ kMismatch
We have as many fragments as requested but they do not match the requested components.
@ kUnassigned14
Status bit 14 is not assigned.
@ kUnassigned4
Status bit 4 is not assigned.
@ kUnassigned2
Status bit 2 is not assigned.
@ kUnassigned16
Status bit 16 is not assigned.
@ kUnassigned27
Status bit 27 is not assigned.
@ kUnassigned10
Status bit 10 is not assigned.
@ kIncomplete
Indicates a trigger record that is missing requested components.
@ kUnassigned9
Status bit 9 is not assigned.
@ kUnassigned24
Status bit 24 is not assigned.
@ kUnassigned7
Status bit 7 is not assigned.
@ kUnassigned28
Status bit 28 is not assigned.
@ kUnassigned21
Status bit 21 is not assigned.
@ kUnassigned3
Status bit 3 is not assigned.
@ kUnassigned31
Status bit 31 is not assigned.
@ kInvalid
Status bit 32 and higher are not valid (status_bits is only 32 bits)
@ kUnassigned18
Status bit 18 is not assigned.
@ kUnassigned25
Status bit 25 is not assigned.
@ kUnassigned19
Status bit 19 is not assigned.
@ kUnassigned5
Status bit 5 is not assigned.
@ kUnassigned29
Status bit 29 is not assigned.
@ kUnassigned23
Status bit 23 is not assigned.
@ kUnassigned11
Status bit 11 is not assigned.
@ kUnassigned15
Status bit 15 is not assigned.
@ kUnassigned17
Status bit 17 is not assigned.
@ kUnassigned22
Status bit 22 is not assigned.
@ kUnassigned12
Status bit 12 is not assigned.
@ kUnassigned30
Status bit 30 is not assigned.
@ kUnassigned8
Status bit 8 is not assigned.
uint16_t sequence_number_t
Type used to represent sequence within a trigger record.
Definition Types.hpp:48
uint64_t timestamp_t
Type used to represent DUNE timing system timestamps.
Definition Types.hpp:36
uint64_t trigger_type_t
Type used to represent Trigger Decision trigger types.
Definition Types.hpp:44
Additional data fields associated with a TriggerRecordHeader.
uint32_t version
Version of the TriggerRecordHeaderData structure.
sequence_number_t max_sequence_number
Maximum sequence number of TriggerRecords corresponding to this trigger.
sequence_number_t sequence_number
Sequence number of this TriggerRecord within the trigger response.
timestamp_t trigger_timestamp
Timestamp of the TriggerDecision.
uint64_t num_requested_components
Number of ComponentRequest objects stored in the TriggerRecordHeader.
uint32_t status_bits
Status bits for the TriggerRecord.
trigger_type_t trigger_type
Type of the TriggerDecision.
static constexpr uint32_t s_trigger_record_header_version
The current version of the TriggerRecordHeader.
uint32_t trigger_record_header_marker
Magic bytes used to identify a TriggerRecordHeaderData struct in a raw data stream.
static constexpr uint32_t s_trigger_record_header_magic
Magic bytes to identify a TriggerRecordHeader entry in a raw data stream.
run_number_t run_number
Run Number for the TriggerRecord.
static constexpr uint32_t s_default_status_bits
By default, all status bits are unset.
static constexpr uint64_t s_invalid_number_components
An invalid number of components.