The RawFragmentHeaderV1 class contains the basic fields used by artdaq for routing Fragment objects through the system.
More...
#include <artdaq-core/Data/detail/RawFragmentHeaderV1.hh>
|
typedef unsigned long long | RawDataType |
| The RawDataType (currently a 64-bit integer) is the basic unit of data representation within artdaq
|
|
typedef uint16_t | version_t |
| version field is 16 bits
|
|
typedef uint64_t | sequence_id_t |
| sequence_id field is 48 bits
|
|
typedef uint8_t | type_t |
| type field is 8 bits
|
|
typedef uint16_t | fragment_id_t |
| fragment_id field is 16 bits
|
|
typedef uint8_t | metadata_word_count_t |
| metadata_word_count field is 8 bits
|
|
typedef uint64_t | timestamp_t |
| timestamp field is 32 bits
|
|
The RawFragmentHeaderV1 class contains the basic fields used by artdaq for routing Fragment objects through the system.
The RawFragmentHeaderV1 class contains the basic fields used by artdaq for routing Fragment objects through the system. It also contains static value definitions of values used in those fields. This is an old version of RawFragmentHeader, provided for compatibility
Definition at line 32 of file RawFragmentHeaderV1.hh.
static std::map<type_t, std::string> artdaq::detail::RawFragmentHeaderV1::MakeSystemTypeMap |
( |
| ) |
|
|
inlinestatic |
Returns a map of the most-commonly used system types.
- Returns
- A map of the system types used in the artdaq data stream
Definition at line 67 of file RawFragmentHeaderV1.hh.
static std::map<type_t, std::string> artdaq::detail::RawFragmentHeaderV1::MakeVerboseSystemTypeMap |
( |
| ) |
|
|
inlinestatic |
Returns a map of all system types.
- Returns
- A map of all defined system types
Definition at line 79 of file RawFragmentHeaderV1.hh.
constexpr std::size_t artdaq::detail::RawFragmentHeaderV1::num_words |
( |
| ) |
|
|
inlinestatic |
Returns the number of RawDataType words present in the header.
- Returns
- The number of RawDataType words present in the header
Definition at line 183 of file RawFragmentHeaderV1.hh.
void artdaq::detail::RawFragmentHeaderV1::setSystemType |
( |
uint8_t |
stype | ) |
|
|
inline |
Sets the type field to the specified system type.
- Parameters
-
stype | The type code to set |
- Exceptions
-
cet::exception | if stype is not in the allowed range for system types |
Definition at line 210 of file RawFragmentHeaderV1.hh.
void artdaq::detail::RawFragmentHeaderV1::setUserType |
( |
uint8_t |
utype | ) |
|
|
inline |
Sets the type field to the specified user type.
- Parameters
-
utype | The type code to set |
- Exceptions
-
cet::exception | if utype is not in the allowed range for user types |
Definition at line 197 of file RawFragmentHeaderV1.hh.
static std::string artdaq::detail::RawFragmentHeaderV1::SystemTypeToString |
( |
type_t |
type | ) |
|
|
inlinestatic |
Print a system type's string name.
- Parameters
-
- Returns
- String with "Name" of type
Definition at line 97 of file RawFragmentHeaderV1.hh.
Upgrades the RawFragmentHeaderV1 to a RawFragmentHeader (Current version)
- Returns
- Current-version RawFragmentHeader
The constraints on RawFragmentHeader upgrades are that no field may shrink in size or be deleted. Therefore, there will always be an upgrade path from old RawFragmentHeaders to new ones. By convention, all fields are initialized to the Invalid defines, and then the old data (guarenteed to be smaller) is cast to the new header. In the case of added fields, they will remain marked Invalid.
Definition at line 222 of file RawFragmentHeaderV1.hh.
The documentation for this struct was generated from the following file: