gdataConventions.h File Reference

Shared constants, schema keys, and error codes for the GData module. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Variables
constexpr int	TIMEATELECTRONICSNOTDEFINED = -123456
	Sentinel value returned when timeAtElectronics is requested but not present.
Error and reporting codes
Stable numeric codes used by GData components when reporting failures. These values are intended to remain stable so that scripts and higher-level tools can classify failures without depending on exact log-message text.
constexpr int	ERR_GSDETECTORNOTFOUND = 601
	Requested sensitive detector entry is missing.
constexpr int	ERR_VARIABLENOTFOUND = 602
	Requested observable key is missing.
constexpr int	ERR_WRONGPAYLOAD = 603
	Packed payload vector has an unexpected size or layout.
Streaming-readout key names
Conventional observable keys used to represent electronics addressing and timing. These keys identify readout coordinates or closely related electronics-level quantities. They are treated specially by the filtered accessors: GDigitizedData::getIntObservablesMap() GDigitizedData::getDblObservablesMap() This separation allows output code to distinguish between: channel-addressing information detector- or digitization-specific physics-like observables
constexpr const char *	CRATESTRINGID = "crate"
	Electronics crate identifier.
constexpr const char *	SLOTSTRINGID = "slot"
	Slot index within the crate.
constexpr const char *	CHANNELSTRINGID = "channel"
	Channel index within the slot or module.
constexpr const char *	CHARGEATELECTRONICS = "chargeAtElectronics"
	Electronics-stage charge or ADC proxy.
constexpr const char *	TIMEATELECTRONICS = "timeAtElectronics"
	Electronics-stage time or TDC proxy.

Detailed Description

This header centralizes common key names and error codes used throughout the module so that:

• producers and consumers use identical observable names
• output backends can rely on stable key spelling
• diagnostics can rely on stable numeric codes

The string constants declared here are part of the public schema contract of this module. Changing one of these values affects interoperability with:

• detector plugins
• exporters
• validation tools
• downstream analysis code

Definition in file gdataConventions.h.

Variable Documentation

CHANNELSTRINGID

constexpr const char* CHANNELSTRINGID = "channel"

constexpr

Definition at line 64 of file gdataConventions.h.

CHARGEATELECTRONICS

constexpr const char* CHARGEATELECTRONICS = "chargeAtElectronics"

constexpr

Definition at line 65 of file gdataConventions.h.

CRATESTRINGID

constexpr const char* CRATESTRINGID = "crate"

constexpr

Definition at line 62 of file gdataConventions.h.

ERR_GSDETECTORNOTFOUND

constexpr int ERR_GSDETECTORNOTFOUND = 601

constexpr

Definition at line 41 of file gdataConventions.h.

ERR_VARIABLENOTFOUND

constexpr int ERR_VARIABLENOTFOUND = 602

constexpr

Definition at line 42 of file gdataConventions.h.

ERR_WRONGPAYLOAD

constexpr int ERR_WRONGPAYLOAD = 603

constexpr

Definition at line 43 of file gdataConventions.h.

SLOTSTRINGID

constexpr const char* SLOTSTRINGID = "slot"

constexpr

Definition at line 63 of file gdataConventions.h.

TIMEATELECTRONICS

constexpr const char* TIMEATELECTRONICS = "timeAtElectronics"

constexpr

Definition at line 66 of file gdataConventions.h.