opatIO-cpp 0.3.0a
Open Parametrized Array Table
Loading...
Searching...
No Matches
opat::CardHeader Struct Reference

Structure to hold the header information of a DataCard in an OPAT file. More...

#include <opatIO.h>

Public Attributes

char magic [4]
 Magic number to identify the card type.
 
uint32_t numTables
 Number of tables in the card.
 
uint32_t headerSize
 Size of the card header in bytes.
 
uint64_t indexOffset
 Offset to the index section within the card.
 
uint64_t cardSize
 Total size of the card in bytes.
 
char comment [128]
 User-defined comment section.
 
char reserved [100]
 Reserved for future use.
 

Friends

std::ostream & operator<< (std::ostream &os, const CardHeader &header)
 Stream insertion operator for printing the card header.
 

Detailed Description

Structure to hold the header information of a DataCard in an OPAT file.

The CardHeader contains metadata about a specific DataCard, such as its size and offsets. It is packed to ensure alignment with the binary file format.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & os,
const CardHeader & header )
friend

Stream insertion operator for printing the card header.

Parameters
osOutput stream.
headerCardHeader to print.
Returns
Reference to the output stream.

Member Data Documentation

◆ cardSize

uint64_t opat::CardHeader::cardSize

Total size of the card in bytes.

◆ comment

char opat::CardHeader::comment[128]

User-defined comment section.

◆ headerSize

uint32_t opat::CardHeader::headerSize

Size of the card header in bytes.

◆ indexOffset

uint64_t opat::CardHeader::indexOffset

Offset to the index section within the card.

◆ magic

char opat::CardHeader::magic[4]

Magic number to identify the card type.

◆ numTables

uint32_t opat::CardHeader::numTables

Number of tables in the card.

◆ reserved

char opat::CardHeader::reserved[100]

Reserved for future use.


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