|
DUNE-DAQ
DUNE Trigger and Data Acquisition software
|
Namespaces | |
| namespace | python |
Classes | |
| struct | ComponentRequest |
| A request sent to a Component, including the SourceID of the component and the window offset and width. More... | |
| class | Fragment |
| C++ Representation of a DUNE Fragment, wrapping the flat byte array that is the Fragment's "actual" form. More... | |
| struct | FragmentHeader |
| The header for a DUNE Fragment. More... | |
| struct | SourceID |
| SourceID is a generalized representation of the source of a piece of data in the DAQ. That source could be a physical location in the detector, a running process in the DAQ (e.g. a dataflow app, the source of a data request), etc. More... | |
| class | TimeSlice |
| C++ Representation of a DUNE TimeSlice, consisting of a TimeSliceHeader object and a vector of pointers to Fragment objects. More... | |
| struct | TimeSliceHeader |
| Additional data fields associated with a TimeSliceHeader. More... | |
| class | TriggerRecord |
| C++ Representation of a DUNE TriggerRecord, consisting of a TriggerRecordHeader object and a vector of pointers to Fragment objects. More... | |
| class | TriggerRecordHeader |
| C++ representation of a TriggerRecordHeader, which wraps a flat array that is the TriggerRecordHeader's "actual" form. More... | |
| struct | TriggerRecordHeaderData |
| Additional data fields associated with a TriggerRecordHeader. More... | |
| class | TypeDefaults |
| Default values for daqdataformats types. More... | |
Typedefs | |
| using | run_number_t = uint32_t |
| Type used to represent run number. | |
| using | trigger_number_t = uint64_t |
| Type used to represent trigger number. | |
| using | fragment_type_t = uint32_t |
| Type used to represent Fragment type ID. | |
| using | fragment_size_t = uint64_t |
| Type used to represent Fragment size. | |
| using | timestamp_t = uint64_t |
| Type used to represent DUNE timing system timestamps. | |
| using | timestamp_diff_t = int64_t |
| Used to represent differences between timestamps. | |
| using | trigger_type_t = uint64_t |
| Type used to represent Trigger Decision trigger types. | |
| using | sequence_number_t = uint16_t |
| Type used to represent sequence within a trigger record. | |
| using | timeslice_number_t = uint64_t |
| Type used to represent timeslice number. | |
Functions | |
| std::ostream & | operator<< (std::ostream &o, ComponentRequest const &cr) |
| Write out a ComponentRequest in human-readable form. | |
| std::istream & | operator>> (std::istream &is, ComponentRequest &cr) |
| Read a ComponentRequest from a string stream. | |
| std::ostream & | operator<< (std::ostream &o, SourceID::Subsystem const &type) |
| Stream a Subsystem instance in a human-readable form. | |
| std::ostream & | operator<< (std::ostream &o, SourceID const &source_id) |
| Stream a SourceID instance in a human-readable form. | |
| std::istream & | operator>> (std::istream &is, SourceID::Subsystem &t) |
| Read a SourceID::Subsystem from a string stream. | |
| std::istream & | operator>> (std::istream &is, SourceID &source_id) |
| Read a SourceID from a string stream. | |
| std::map< FragmentType, std::string > | get_fragment_type_names () |
| This map relates FragmentType values to string names. | |
| std::string | fragment_type_to_string (const FragmentType &type) |
| Convert a FragmentType enum value to string. | |
| FragmentType | string_to_fragment_type (const std::string &name) |
| Convert a string to a FragmentType value. | |
| std::ostream & | operator<< (std::ostream &o, FragmentHeader const &hdr) |
| Stream a Fragment Header in human-readable form. | |
| std::istream & | operator>> (std::istream &o, FragmentHeader &hdr) |
| Read a FragmentHeader instance from a string stream. | |
| std::ostream & | operator<< (std::ostream &o, TimeSliceHeader const &hdr) |
| Stream a TimeSliceHeader instance in human-readable form. | |
| std::istream & | operator>> (std::istream &o, TimeSliceHeader &hdr) |
| Read a TimeSliceHeader instance from a string stream. | |
| std::ostream & | operator<< (std::ostream &o, TriggerRecordHeaderData const &hdr) |
| Stream a TriggerRecordHeaderData instance in human-readable form. | |
| std::istream & | operator>> (std::istream &o, TriggerRecordHeaderData &hdr) |
| Read a TriggerRecordHeaderData instance from a string stream. | |
| using dunedaq::daqdataformats::fragment_size_t = uint64_t |
| using dunedaq::daqdataformats::fragment_type_t = uint32_t |
| using dunedaq::daqdataformats::run_number_t = uint32_t |
| using dunedaq::daqdataformats::sequence_number_t = uint16_t |
| using dunedaq::daqdataformats::timeslice_number_t = uint64_t |
| using dunedaq::daqdataformats::timestamp_diff_t = int64_t |
| using dunedaq::daqdataformats::timestamp_t = uint64_t |
| using dunedaq::daqdataformats::trigger_number_t = uint64_t |
| using dunedaq::daqdataformats::trigger_type_t = uint64_t |
Type used to represent Trigger Decision trigger types.
This field is a bitset mapping to this enum: https://github.com/DUNE-DAQ/trgdataformats/blob/develop/include/trgdataformats/TriggerCandidateData.hpp#L22
|
strong |
This enumeration should list all defined status bits, as well as a short documentation of their meaning.
| Enumerator | |
|---|---|
| kLatencyBufferEmpty | The latency buffer had zero occupancy when the data request was made. |
| kIncomplete | Only part of the requested data is present in the fragment. |
| kInvalidRequestWindow | The requested data window was too large. |
| kRequestTimeout | A timeout occurred while processing the data request. |
| kRequestWindowBeforeBuffer | The request window extends before the latency buffer start. |
| kRequestWindowAfterBuffer | The request window extends after the latency buffer end. |
| kEmptyFragment | This Fragment contains no data. |
| kUnassigned7 | Status bit 7 is not assigned. |
| kUnassigned8 | Status bit 8 is not assigned. |
| kUnassigned9 | Status bit 9 is not assigned. |
| kUnassigned10 | Status bit 10 is not assigned. |
| kUnassigned11 | Status bit 11 is not assigned. |
| kUnassigned12 | Status bit 12 is not assigned. |
| kUnassigned13 | Status bit 13 is not assigned. |
| kUnassigned14 | Status bit 14 is not assigned. |
| kUnassigned15 | Status bit 15 is not assigned. |
| kUnassigned16 | Status bit 16 is not assigned. |
| kUnassigned17 | Status bit 17 is not assigned. |
| kUnassigned18 | Status bit 18 is not assigned. |
| kUnassigned19 | Status bit 19 is not assigned. |
| kUnassigned20 | Status bit 20 is not assigned. |
| kUnassigned21 | Status bit 21 is not assigned. |
| kUnassigned22 | Status bit 22 is not assigned. |
| kUnassigned23 | Status bit 23 is not assigned. |
| kUnassigned24 | Status bit 24 is not assigned. |
| kUnassigned25 | Status bit 25 is not assigned. |
| kUnassigned26 | Status bit 26 is not assigned. |
| kUnassigned27 | Status bit 27 is not assigned. |
| kUnassigned28 | Status bit 28 is not assigned. |
| kUnassigned29 | Status bit 29 is not assigned. |
| kUnassigned30 | Status bit 30 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) |
Definition at line 144 of file FragmentHeader.hpp.
|
strong |
This enumeration should list all defined Fragment types.
Definition at line 184 of file FragmentHeader.hpp.
|
strong |
This enumeration should list all defined status bits, as well as a short documentation of their meaning.
Definition at line 140 of file TriggerRecordHeaderData.hpp.
|
inline |
Convert a FragmentType enum value to string.
| type | Type to convert |
Definition at line 256 of file FragmentHeader.hpp.
|
inline |
This map relates FragmentType values to string names.
These names can be used, for example, as HDF5 Group names
Definition at line 224 of file FragmentHeader.hpp.
|
inline |
Write out a ComponentRequest in human-readable form.
| o | Output stream |
| cr | ComponentRequest to write |
Definition at line 70 of file ComponentRequest.hpp.
|
inline |
Stream a Fragment Header in human-readable form.
| o | Stream to write to |
| hdr | FragmentHeader to stream |
Definition at line 286 of file FragmentHeader.hpp.
|
inline |
Stream a SourceID instance in a human-readable form.
| o | Stream to output to |
| id | SourceID to stream |
Definition at line 30 of file SourceID.hxx.
|
inline |
Stream a Subsystem instance in a human-readable form.
| o | Stream to output to |
| id | Subsystem to stream |
Definition at line 18 of file SourceID.hxx.
|
inline |
Stream a TimeSliceHeader instance in human-readable form.
| o | Stream to write to |
| hdr | TimeSliceHeader to write |
Definition at line 82 of file TimeSliceHeader.hpp.
|
inline |
Stream a TriggerRecordHeaderData instance in human-readable form.
| o | Stream to write to |
| hdr | TriggerRecordHeaderData to write |
Definition at line 183 of file TriggerRecordHeaderData.hpp.
|
inline |
Read a ComponentRequest from a string stream.
| is | Input stream |
| cr | ComponentRequest to read |
Definition at line 83 of file ComponentRequest.hpp.
|
inline |
Read a SourceID from a string stream.
| is | Stream to read from |
| id | SourceID to fill |
Definition at line 60 of file SourceID.hxx.
|
inline |
Read a SourceID::Subsystem from a string stream.
| is | Stream to read from |
| id | Subsystem to fill |
Definition at line 43 of file SourceID.hxx.
|
inline |
Read a FragmentHeader instance from a string stream.
| is | Stream to read from |
| hdr | FragmentHeader to read |
Definition at line 305 of file FragmentHeader.hpp.
|
inline |
Read a TimeSliceHeader instance from a string stream.
| is | Stream to read from |
| hdr | TimeSliceHeader toread |
Definition at line 100 of file TimeSliceHeader.hpp.
|
inline |
Read a TriggerRecordHeaderData instance from a string stream.
| is | Stream to read from |
| hdr | TriggerRecordHeaderData toread |
Definition at line 206 of file TriggerRecordHeaderData.hpp.
|
inline |
Convert a string to a FragmentType value.
| name | Name of the type |
Definition at line 271 of file FragmentHeader.hpp.