Project
Loading...
Searching...
No Matches
o2::cpv::CPVBlockHeader Struct Reference

Header for CPV flagging the following CPV payload. More...

#include <CPVBlockHeader.h>

Inherits o2::header::BaseHeader.

Public Member Functions

 CPVBlockHeader (bool hasPayload)
 
- 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 BaseHeadernext () const noexcept
 get the next header if any (const version)
 
BaseHeadernext () noexcept
 get the next header if any (non-const version)
 
bool sanityCheck (uint32_t expectedVersion) const
 
void throwInconsistentStackError () const
 

Public Attributes

bool mHasPayload
 Field specifying whether the data block has payload.
 
- 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 o2::header::HeaderType sHeaderType = "CPVBlkH"
 
static const uint32_t sVersion = 1
 
- 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 BaseHeaderget (const std::byte *b, size_t=0)
 access header in buffer
 
static BaseHeaderget (std::byte *b, size_t=0)
 access header in buffer
 

Detailed Description

Header for CPV flagging the following CPV payload.

Definition at line 24 of file CPVBlockHeader.h.

Constructor & Destructor Documentation

◆ CPVBlockHeader()

o2::cpv::CPVBlockHeader::CPVBlockHeader ( bool  hasPayload)
inline

Definition at line 29 of file CPVBlockHeader.h.

Member Data Documentation

◆ mHasPayload

bool o2::cpv::CPVBlockHeader::mHasPayload

Field specifying whether the data block has payload.

Definition at line 31 of file CPVBlockHeader.h.

◆ sHeaderType

constexpr o2::header::HeaderType o2::cpv::CPVBlockHeader::sHeaderType = "CPVBlkH"
staticconstexpr

Definition at line 26 of file CPVBlockHeader.h.

◆ sVersion

const uint32_t o2::cpv::CPVBlockHeader::sVersion = 1
static

Definition at line 27 of file CPVBlockHeader.h.


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