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

#include <opatIO.h>

Public Member Functions
void	print () const
	Prints the header information to the console.

Public Attributes
char	magic [4]
	Magic number to identify the file type.

uint16_t	version
	Version of the OPAT file format.

uint32_t	numTables
	Number of tables in the file.

uint32_t	headerSize
	Size of the header in bytes.

uint64_t	indexOffset
	Offset to the index section.

char	creationDate [16]
	Creation date of the file (e.g., "YYYY-MM-DD HH:MM").

char	sourceInfo [64]
	Source information (e.g., software version or author).

char	comment [128]
	User-defined comment section.

uint16_t	numIndex
	Size of the index vector per table.

uint8_t	hashPrecision
	Precision of the hash used for table validation.

char	reserved [23]
	Reserved for future use.

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

Detailed Description

Structure to hold the header information of an OPAT file.

The header contains metadata about the file, such as its version, creation date, and offsets to the card catalog and start of the data section. It is packed to ensure compactness and alignment with the binary file format.

Member Function Documentation

◆ print()

void opat::Header::print ( ) const

Prints the header information to the console.

Friends And Related Symbol Documentation

◆ operator<<

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

friend

Stream insertion operator for printing the header.

Parameters

os	Output stream.
header	Header to print.

Returns: Reference to the output stream.

Member Data Documentation

◆ comment

char opat::Header::comment[128]

User-defined comment section.

◆ creationDate

char opat::Header::creationDate[16]

Creation date of the file (e.g., "YYYY-MM-DD HH:MM").

◆ hashPrecision

uint8_t opat::Header::hashPrecision

Precision of the hash used for table validation.

◆ headerSize

uint32_t opat::Header::headerSize

Size of the header in bytes.

◆ indexOffset

uint64_t opat::Header::indexOffset

Offset to the index section.

◆ magic

char opat::Header::magic[4]

Magic number to identify the file type.

◆ numIndex

uint16_t opat::Header::numIndex

Size of the index vector per table.

◆ numTables

uint32_t opat::Header::numTables

Number of tables in the file.

◆ reserved

char opat::Header::reserved[23]

Reserved for future use.

◆ sourceInfo

char opat::Header::sourceInfo[64]

Source information (e.g., software version or author).

◆ version

uint16_t opat::Header::version

Version of the OPAT file format.

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

src/public/opatIO.h
src/private/opatIO.cpp

Public Member Functions

Public Attributes

Friends