XTC2
Classes
Section titled “Classes”| Name | Description |
|---|---|
Alg |
|
AlgVersion |
|
Damage |
|
Data |
|
DataDescr |
|
DataResult |
A small struct that returns all necessary information to access a payload in a datagram. When a detector/segment/algorithm/field combination is specified, the return type will be this struct which provides the pointer to the data, the shape and size of the payload, and the data type. |
Dgram |
|
MetadataCollector |
|
Name |
|
NameInfo |
|
Names |
|
NamesId |
|
Shape |
|
Shapes |
|
ShapesData |
|
Src |
|
TypeId |
|
Xtc |
|
XtcDetectorDescr |
|
XtcFieldDescr |
Enumerations
Section titled “Enumerations”| Name | Description |
|---|---|
DType |
|
TransitionId |
enum DType| Value | Description |
|---|---|
UINT8 |
|
UINT16 |
|
UINT32 |
|
UINT64 |
|
INT8 |
|
INT16 |
|
INT32 |
|
INT64 |
|
FLOAT |
|
DOUBLE |
|
CHARSTR |
|
ENUMVAL |
|
ENUMDICT |
TransitionId
Section titled “TransitionId”enum TransitionId| Value | Description |
|---|---|
ClearReadout |
|
Reset |
|
Configure |
|
Unconfigure |
|
BeginRun |
|
EndRun |
|
BeginStep |
|
EndStep |
|
Enable |
|
Disable |
|
SlowUpdate |
|
Unused_11 |
|
L1Accept |
|
NumberOf |
Functions
Section titled “Functions”| Return | Name | Description |
|---|---|---|
SBIO_HD void |
handle_xtc2_names |
|
SBIO_HD void |
handle_xtc2_shapes_data |
|
SBIO_HD void |
inspect_xtc2 |
|
SBIO_HDDataResult |
resolve_xtc2_pointer |
handle_xtc2_names
Section titled “handle_xtc2_names”SBIO_HD void handle_xtc2_names(XTC2::Names * names, MetadataCollector & collector, std::uint32_t offset)handle_xtc2_shapes_data
Section titled “handle_xtc2_shapes_data”SBIO_HD void handle_xtc2_shapes_data(XTC2::ShapesData * sd, MetadataCollector & collector, std::uint32_t current_offset)inspect_xtc2
Section titled “inspect_xtc2”SBIO_HD void inspect_xtc2(XTC2::Xtc * xtc, MetadataCollector & collector, std::uint32_t current_offset)resolve_xtc2_pointer
Section titled “resolve_xtc2_pointer”SBIO_HDDataResult resolve_xtc2_pointer(void * buffer, std::uint32_t sd_offset, const Name * field_schema, std::uint32_t nid, std::uint32_t f_idx)Variables
Section titled “Variables”| Return | Name | Description |
|---|---|---|
constexpr auto |
MaxRank constexpr |
|
constexpr auto |
MaxNameSize constexpr |
|
constexpr std::array< char[10], 13 > |
DTypeString static constexpr |
|
constexpr std::array< std::uint8_t, 13 > |
DTypeSize static constexpr |
|
constexpr std::array< char[13], 14 > |
TransitionIdString static constexpr |
|
constexpr std::array< char[11], 6 > |
TypeIdString static constexpr |
MaxRank
Section titled “MaxRank”constexpr
constexpr auto MaxRank = 5MaxNameSize
Section titled “MaxNameSize”constexpr
constexpr auto MaxNameSize = 256DTypeString
Section titled “DTypeString”static constexpr
constexpr std::array< char[10], 13 > DTypeString { "UINT8", "UINT16", "UINT32", "UINT64", "INT8", "INT16", "INT32", "INT64", "FLOAT", "DOUBLE", "CHARSTR", "ENUMVAL", "ENUMDICT" }DTypeSize
Section titled “DTypeSize”static constexpr
constexpr std::array< std::uint8_t, 13 > DTypeSize { sizeof(std::uint8_t), sizeof(std::uint16_t), sizeof(std::uint32_t), sizeof(std::uint64_t), sizeof(std::int8_t), sizeof(std::int16_t), sizeof(std::int32_t), sizeof(std::int64_t), sizeof(float), sizeof(double), sizeof(std::int32_t), sizeof(std::int32_t) }TransitionIdString
Section titled “TransitionIdString”static constexpr
constexpr std::array< char[13], 14 > TransitionIdString { "ClearReadout", "Reset", "Configure", "Unconfigure", "BeginRun", "EndRun", "BeginStep", "EndStep", "Enable", "Disable", "SlowUpdate", "Unused_11", "L1Accept", "NumberOf" }TypeIdString
Section titled “TypeIdString”static constexpr
constexpr std::array< char[11], 6 > TypeIdString { "Parent", "ShapesData", "Shapes", "Data", "Names", "NumberOf" }