readout_type_descriptions.h File Reference

Canonical C-struct description strings for the EFU-sendable readout types. More...

#include "enums.h"

Include dependency graph for readout_type_descriptions.h:

Go to the source code of this file.

Functions
RL_API const char *	readout_type_description (ReadoutType readout)
	The canonical struct description for a sendable readout type.

Detailed Description

Canonical C-struct description strings for the EFU-sendable readout types.

These strings are the single source of truth for the record layout that a description-based collector must use to remain EFU-sendable: parsing one with TypeDescriptionParser and building the HDF5 compound type must produce a type exactly equal to hdf_compound_type(readout) — a unit test enforces this, so the strings cannot drift from the C++ event structs in hdf_interface.h.

Definition in file readout_type_descriptions.h.

Macro Definition Documentation

RL_API

#define RL_API

Definition at line 32 of file readout_type_descriptions.h.

Function Documentation

readout_type_description()

RL_API const char * readout_type_description

(

ReadoutType

readout

)

The canonical struct description for a sendable readout type.

Returns

a parseable C-struct field list whose compound type equals hdf_compound_type(readout), or nullptr for types without a canonical description