o2::framework::OutputObjHeader Struct Reference

O2 header for OutputObj metadata. More...

#include <OutputObjHeader.h>

Inherits o2::header::BaseHeader.

Public Member Functions
constexpr	OutputObjHeader ()
constexpr	OutputObjHeader (OutputObjHandlingPolicy policy, OutputObjSourceType sourceType, uint32_t hash, uint16_t pipelineIndex, uint16_t pipelineSize)
constexpr	OutputObjHeader (OutputObjHeader const &)=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

Public Attributes
OutputObjHandlingPolicy	mPolicy
OutputObjSourceType	mSourceType
uint32_t	mTaskHash
uint16_t	mPipelineIndex = 0
uint16_t	mPipelineSize = 1
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 constexpr const uint32_t	sVersion = 1
static constexpr const o2::header::HeaderType	sHeaderType = "OutObjMD"
static constexpr const o2::header::SerializationMethod	sSerializationMethod = o2::header::gSerializationMethodNone
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

Additional Inherited Members
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

Detailed Description

O2 header for OutputObj metadata.

Definition at line 38 of file OutputObjHeader.h.

Constructor & Destructor Documentation

OutputObjHeader() [1/3]

constexpr o2::framework::OutputObjHeader::OutputObjHeader ( )

inlineconstexpr

Definition at line 48 of file OutputObjHeader.h.

OutputObjHeader() [2/3]

constexpr o2::framework::OutputObjHeader::OutputObjHeader ( OutputObjHandlingPolicy  policy, OutputObjSourceType  sourceType, uint32_t  hash, uint16_t  pipelineIndex, uint16_t  pipelineSize  )

inlineconstexpr

Definition at line 53 of file OutputObjHeader.h.

OutputObjHeader() [3/3]

constexpr o2::framework::OutputObjHeader::OutputObjHeader ( OutputObjHeader const &  )

constexprdefault

Member Data Documentation

mPipelineIndex

uint16_t o2::framework::OutputObjHeader::mPipelineIndex = 0

Definition at line 45 of file OutputObjHeader.h.

mPipelineSize

uint16_t o2::framework::OutputObjHeader::mPipelineSize = 1

Definition at line 46 of file OutputObjHeader.h.

mPolicy

OutputObjHandlingPolicy o2::framework::OutputObjHeader::mPolicy

Definition at line 42 of file OutputObjHeader.h.

mSourceType

OutputObjSourceType o2::framework::OutputObjHeader::mSourceType

Definition at line 43 of file OutputObjHeader.h.

mTaskHash

uint32_t o2::framework::OutputObjHeader::mTaskHash

Definition at line 44 of file OutputObjHeader.h.

sHeaderType

constexpr const o2::header::HeaderType o2::framework::OutputObjHeader::sHeaderType = "OutObjMD"

staticconstexpr

Definition at line 40 of file OutputObjHeader.h.

sSerializationMethod

constexpr const o2::header::SerializationMethod o2::framework::OutputObjHeader::sSerializationMethod = o2::header::gSerializationMethodNone

staticconstexpr

Definition at line 41 of file OutputObjHeader.h.

sVersion

constexpr const uint32_t o2::framework::OutputObjHeader::sVersion = 1

staticconstexpr

Definition at line 39 of file OutputObjHeader.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Framework/Core/include/Framework/OutputObjHeader.h