o2::utilities::DataSamplingHeader Struct Reference

#include <DataSamplingHeader.h>

Inherits o2::header::BaseHeader.

Public Types
using	DeviceIDType = header::Descriptor< deviceIDTypeSize >

Public Member Functions
	DataSamplingHeader ()=delete
	DataSamplingHeader (uint64_t _sampleTimeUs, uint32_t _totalAcceptedMessages, uint32_t _totalEvaluatedMessages, DeviceIDType _deviceID, header::DataHeader const &original)
	DataSamplingHeader (const DataSamplingHeader &)=default
DataSamplingHeader &	operator= (const DataSamplingHeader &)=default
Public Member Functions inherited from o2::header::BaseHeader
	BaseHeader ()=delete
	dont construct directly
	BaseHeader (const BaseHeader &)=default
constexpr	BaseHeader (uint32_t mySize, HeaderType desc, SerializationMethod ser, uint32_t version)
	Special ctor for initialization in derived types.
constexpr uint32_t	size () const noexcept
const std::byte *	data () const noexcept
const BaseHeader *	next () const noexcept
	get the next header if any (const version)
BaseHeader *	next () noexcept
	get the next header if any (non-const version)
bool	sanityCheck (uint32_t expectedVersion) const
void	throwInconsistentStackError () const

Static Public Member Functions
static const DataSamplingHeader *	Get (const BaseHeader *baseHeader)
Static Public Member Functions inherited from o2::header::BaseHeader
static const BaseHeader *	get (const std::byte *b, size_t=0)
	access header in buffer
static BaseHeader *	get (std::byte *b, size_t=0)
	access header in buffer

Public Attributes
uint64_t	sampleTimeUs = 0
uint32_t	totalAcceptedMessages = 0
uint32_t	totalEvaluatedMessages = 0
DeviceIDType	deviceID = ""
header::DataDescription	dataDescription
	Presampled description for the data. Copied from the original DataHeader.
header::DataOrigin	dataOrigin
	Presampled origin for the data. Copied from the original DataHeader.
header::DataHeader::SubSpecificationType	subSpecification
	Presampled subSpecification for the data.
Public Attributes inherited from o2::header::BaseHeader
union {
char   magicString [gSizeMagicString]
uint32_t   magicStringInt
};
	a magic string, used to identify an O2 header in a raw stream of bytes
uint32_t	headerSize
union {
uint32_t   flags
struct {
uint32_t   flagsNextHeader: 1
uint32_t   flagsReserved: 15
uint32_t   flagsDerivedHeader: 16
}
};
	flags, first bit indicates that a sub header follows
uint32_t	headerVersion
	version of the entire header, set by the derived header
o2::header::HeaderType	description
	header type description, set by derived header
o2::header::SerializationMethod	serialization
	header serialization method, set by derived header

Static Public Attributes
static const uint32_t	sVersion = 1
static const o2::header::HeaderType	sHeaderType = header::String2<uint64_t>("DataSamp")
static const o2::header::SerializationMethod	sSerializationMethod = o2::header::gSerializationMethodNone
static constexpr uint32_t	deviceIDTypeSize = 16
Static Public Attributes inherited from o2::header::BaseHeader
static constexpr uint32_t	sMagicString {String2<uint32_t>("O2O2")}
static const uint32_t	sVersion = o2::header::gInvalidToken32
static const o2::header::HeaderType	sHeaderType = o2::header::gInvalidToken64
static const o2::header::SerializationMethod	sSerializationMethod = o2::header::gInvalidToken64

Detailed Description

Definition at line 27 of file DataSamplingHeader.h.

Member Typedef Documentation

DeviceIDType

using o2::utilities::DataSamplingHeader::DeviceIDType = header::Descriptor<deviceIDTypeSize>

Definition at line 36 of file DataSamplingHeader.h.

Constructor & Destructor Documentation

DataSamplingHeader() [1/3]

o2::utilities::DataSamplingHeader::DataSamplingHeader ( )

delete

DataSamplingHeader() [2/3]

o2::utilities::DataSamplingHeader::DataSamplingHeader	(	uint64_t	_sampleTimeUs,
		uint32_t	_totalAcceptedMessages,
		uint32_t	_totalEvaluatedMessages,
		DeviceIDType	_deviceID,
		header::DataHeader const &	original
	)

Definition at line 22 of file DataSamplingHeader.cxx.

DataSamplingHeader() [3/3]

o2::utilities::DataSamplingHeader::DataSamplingHeader ( const DataSamplingHeader &  )

default

Member Function Documentation

Get()

const DataSamplingHeader * o2::utilities::DataSamplingHeader::Get ( const BaseHeader *  baseHeader )

static

Definition at line 34 of file DataSamplingHeader.cxx.

operator=()

DataSamplingHeader & o2::utilities::DataSamplingHeader::operator= ( const DataSamplingHeader &  )

default

Member Data Documentation

dataDescription

header::DataDescription o2::utilities::DataSamplingHeader::dataDescription

Presampled description for the data. Copied from the original DataHeader.

Definition at line 45 of file DataSamplingHeader.h.

dataOrigin

header::DataOrigin o2::utilities::DataSamplingHeader::dataOrigin

Presampled origin for the data. Copied from the original DataHeader.

Definition at line 47 of file DataSamplingHeader.h.

deviceID

DeviceIDType o2::utilities::DataSamplingHeader::deviceID = ""

Definition at line 42 of file DataSamplingHeader.h.

deviceIDTypeSize

constexpr uint32_t o2::utilities::DataSamplingHeader::deviceIDTypeSize = 16

staticconstexpr

Definition at line 34 of file DataSamplingHeader.h.

sampleTimeUs

uint64_t o2::utilities::DataSamplingHeader::sampleTimeUs = 0

Definition at line 39 of file DataSamplingHeader.h.

sHeaderType

const o2::header::HeaderType o2::utilities::DataSamplingHeader::sHeaderType = header::String2<uint64_t>("DataSamp")

static

Definition at line 31 of file DataSamplingHeader.h.

sSerializationMethod

const o2::header::SerializationMethod o2::utilities::DataSamplingHeader::sSerializationMethod = o2::header::gSerializationMethodNone

static

Definition at line 32 of file DataSamplingHeader.h.

subSpecification

header::DataHeader::SubSpecificationType o2::utilities::DataSamplingHeader::subSpecification

Presampled subSpecification for the data.

Definition at line 49 of file DataSamplingHeader.h.

sVersion

const uint32_t o2::utilities::DataSamplingHeader::sVersion = 1

static

Definition at line 30 of file DataSamplingHeader.h.

totalAcceptedMessages

uint32_t o2::utilities::DataSamplingHeader::totalAcceptedMessages = 0

Definition at line 40 of file DataSamplingHeader.h.

totalEvaluatedMessages

uint32_t o2::utilities::DataSamplingHeader::totalEvaluatedMessages = 0

Definition at line 41 of file DataSamplingHeader.h.

---

The documentation for this struct was generated from the following files:

• /home/runner/work/AliceO2/AliceO2/Utilities/DataSampling/include/DataSampling/DataSamplingHeader.h
• /home/runner/work/AliceO2/AliceO2/Utilities/DataSampling/src/DataSamplingHeader.cxx