HIPO  4.3.0
High Performance Output data format for experimental physics
hipo::recordHeader_t Struct Reference

Header structure for a HIPO record. More...

#include <record.h>

Public Attributes

int signatureString {}
 Identifier string "HREC" (int = 0x43455248). More...
 
int recordLength {}
 Total length of the record, including the index array. More...
 
int recordDataLength {}
 Length of the uncompressed data buffer. More...
 
int recordDataLengthCompressed {}
 Length of the compressed data buffer. More...
 
int numberOfEvents {}
 Number of events (data buckets) in the data buffer. More...
 
int headerLength {}
 Length of the record header buffer. More...
 
int indexDataLength {}
 Length of the index buffer in bytes. More...
 
int userHeaderLength {}
 User header length in bytes. More...
 
int userHeaderLengthPadding {}
 Padding added to the user header length. More...
 
int bitInfo {}
 Bit-packed information field. More...
 
int compressionType {}
 Compression algorithm identifier. More...
 
int compressedLengthPadding {}
 Padding added to the compressed data length. More...
 
int dataEndianness {}
 Endianness of the stored data. More...
 

Detailed Description

Header structure for a HIPO record.

Contains metadata fields describing the layout, sizes, and compression properties of a single HIPO record as stored on disk.

Definition at line 68 of file record.h.

Member Data Documentation

◆ bitInfo

int hipo::recordHeader_t::bitInfo {}

Bit-packed information field.

Definition at line 78 of file record.h.

◆ compressedLengthPadding

int hipo::recordHeader_t::compressedLengthPadding {}

Padding added to the compressed data length.

Definition at line 80 of file record.h.

◆ compressionType

int hipo::recordHeader_t::compressionType {}

Compression algorithm identifier.

Definition at line 79 of file record.h.

◆ dataEndianness

int hipo::recordHeader_t::dataEndianness {}

Endianness of the stored data.

Definition at line 81 of file record.h.

◆ headerLength

int hipo::recordHeader_t::headerLength {}

Length of the record header buffer.

Definition at line 74 of file record.h.

◆ indexDataLength

int hipo::recordHeader_t::indexDataLength {}

Length of the index buffer in bytes.

Definition at line 75 of file record.h.

◆ numberOfEvents

int hipo::recordHeader_t::numberOfEvents {}

Number of events (data buckets) in the data buffer.

Definition at line 73 of file record.h.

◆ recordDataLength

int hipo::recordHeader_t::recordDataLength {}

Length of the uncompressed data buffer.

Definition at line 71 of file record.h.

◆ recordDataLengthCompressed

int hipo::recordHeader_t::recordDataLengthCompressed {}

Length of the compressed data buffer.

Definition at line 72 of file record.h.

◆ recordLength

int hipo::recordHeader_t::recordLength {}

Total length of the record, including the index array.

Definition at line 70 of file record.h.

◆ signatureString

int hipo::recordHeader_t::signatureString {}

Identifier string "HREC" (int = 0x43455248).

Definition at line 69 of file record.h.

◆ userHeaderLength

int hipo::recordHeader_t::userHeaderLength {}

User header length in bytes.

Definition at line 76 of file record.h.

◆ userHeaderLengthPadding

int hipo::recordHeader_t::userHeaderLengthPadding {}

Padding added to the user header length.

Definition at line 77 of file record.h.


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