HIPO4 C++ Library 4.4.1
Columnar I/O library for CLAS12 physics data
Loading...
Searching...
No Matches
hipo::FileInfo Struct Reference

Metadata container for a file in the chain. More...

#include <chain.h>

Public Member Functions

 FileInfo ()=default
 
 FileInfo (std::string_view name, int idx)
 
bool metadata_loaded () const noexcept
 Check if metadata has been loaded.
 
std::string size_string () const
 Get human-readable file size string.
 

Public Attributes

std::string filename
 
int index {0}
 
long total_events {-1}
 
int num_records {-1}
 
std::uintmax_t file_size {0}
 
bool is_valid {true}
 
std::string error_message
 

Detailed Description

Metadata container for a file in the chain.

Constructor & Destructor Documentation

◆ FileInfo() [1/2]

hipo::FileInfo::FileInfo ( )
default

◆ FileInfo() [2/2]

hipo::FileInfo::FileInfo ( std::string_view  name,
int  idx 
)
inline

Member Function Documentation

◆ metadata_loaded()

bool hipo::FileInfo::metadata_loaded ( ) const
inlinenoexcept

Check if metadata has been loaded.

◆ size_string()

std::string hipo::FileInfo::size_string ( ) const
inline

Get human-readable file size string.

Member Data Documentation

◆ filename

std::string hipo::FileInfo::filename

◆ index

int hipo::FileInfo::index {0}

◆ total_events

long hipo::FileInfo::total_events {-1}

◆ num_records

int hipo::FileInfo::num_records {-1}

◆ file_size

std::uintmax_t hipo::FileInfo::file_size {0}

◆ is_valid

bool hipo::FileInfo::is_valid {true}

◆ error_message

std::string hipo::FileInfo::error_message

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