Project
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
o2::ctf::Metadata Struct Reference

#include <Metadata.h>

Public Types

enum class  OptStore : uint8_t {
  EENCODE , ROOTCompression , NONE , NODATA ,
  PACK , EENCODE_OR_PACK
}
 

Public Member Functions

size_t getUncompressedSize () const
 Uncompressed size of stored data in bytes.
 
size_t getCompressedSize () const
 Size of the stored, compressed data in multiples of the underlying buffer word size.
 
void clear ()
 
 ClassDefNV (Metadata, 3)
 

Public Attributes

uint8_t nStreams = 0
 
size_t messageLength = 0
 
size_t nLiterals = 0
 
uint8_t messageWordSize = 0
 
uint8_t coderType = 0
 
uint8_t streamSize = 0
 
uint8_t probabilityBits = 0
 
OptStore opt = OptStore::EENCODE
 
int32_t min = 0
 
int32_t max = 0
 
int32_t literalsPackingOffset = 0
 
uint8_t literalsPackingWidth = 0
 
int nDictWords = 0
 
int nDataWords = 0
 
int nLiteralWords = 0
 

Detailed Description

Definition at line 26 of file Metadata.h.

Member Enumeration Documentation

◆ OptStore

enum class o2::ctf::Metadata::OptStore : uint8_t
strong
Enumerator
EENCODE 
ROOTCompression 
NONE 
NODATA 
PACK 
EENCODE_OR_PACK 

Definition at line 27 of file Metadata.h.

Member Function Documentation

◆ ClassDefNV()

o2::ctf::Metadata::ClassDefNV ( Metadata  ,
3   
)

◆ clear()

void o2::ctf::Metadata::clear ( )
inline

Definition at line 66 of file Metadata.h.

◆ getCompressedSize()

size_t o2::ctf::Metadata::getCompressedSize ( ) const
inline

Size of the stored, compressed data in multiples of the underlying buffer word size.

Returns
size_t The size in multiples of the underlying buffer word size
Warning
This size is in number of words of the underlying storage buffer. Multiply with the size of the storage buffer type to get the correct size in bytes.

Definition at line 65 of file Metadata.h.

◆ getUncompressedSize()

size_t o2::ctf::Metadata::getUncompressedSize ( ) const
inline

Uncompressed size of stored data in bytes.

Returns
size_t Uncompressed size in bytes

Definition at line 56 of file Metadata.h.

Member Data Documentation

◆ coderType

uint8_t o2::ctf::Metadata::coderType = 0

Definition at line 39 of file Metadata.h.

◆ literalsPackingOffset

int32_t o2::ctf::Metadata::literalsPackingOffset = 0

Definition at line 45 of file Metadata.h.

◆ literalsPackingWidth

uint8_t o2::ctf::Metadata::literalsPackingWidth = 0

Definition at line 46 of file Metadata.h.

◆ max

int32_t o2::ctf::Metadata::max = 0

Definition at line 44 of file Metadata.h.

◆ messageLength

size_t o2::ctf::Metadata::messageLength = 0

Definition at line 36 of file Metadata.h.

◆ messageWordSize

uint8_t o2::ctf::Metadata::messageWordSize = 0

Definition at line 38 of file Metadata.h.

◆ min

int32_t o2::ctf::Metadata::min = 0

Definition at line 43 of file Metadata.h.

◆ nDataWords

int o2::ctf::Metadata::nDataWords = 0

Definition at line 48 of file Metadata.h.

◆ nDictWords

int o2::ctf::Metadata::nDictWords = 0

Definition at line 47 of file Metadata.h.

◆ nLiterals

size_t o2::ctf::Metadata::nLiterals = 0

Definition at line 37 of file Metadata.h.

◆ nLiteralWords

int o2::ctf::Metadata::nLiteralWords = 0

Definition at line 49 of file Metadata.h.

◆ nStreams

uint8_t o2::ctf::Metadata::nStreams = 0

Definition at line 35 of file Metadata.h.

◆ opt

OptStore o2::ctf::Metadata::opt = OptStore::EENCODE

Definition at line 42 of file Metadata.h.

◆ probabilityBits

uint8_t o2::ctf::Metadata::probabilityBits = 0

Definition at line 41 of file Metadata.h.

◆ streamSize

uint8_t o2::ctf::Metadata::streamSize = 0

Definition at line 40 of file Metadata.h.

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