vlink::BagReader::Info Struct Reference

Metadata extracted from the bag file header and index. More...

#include <bag_reader.h>

Collaboration diagram for vlink::BagReader::Info:

Classes
struct	UrlMeta
	Per-URL statistics extracted from the bag index. More...

Public Attributes
std::string	file_name
	Absolute path to the bag file.
std::string	tag_name
	Tag name stored in the bag header.
std::string	version
	Bag format version string.
std::string	storage_type
	Storage backend (e.g., "sqlite", "mcap").
std::string	compression_type
	Compression algorithm used (e.g., "lzav", "zstd").
std::string	time_accuracy
	Timestamp resolution (e.g., "us", "ns").
std::string	process_name
	Name of the recording process.
std::string	date_time
	Recording start date/time string.
bool	has_completed {false}
	true if the recording was cleanly finalized.
bool	has_idx_elapsed {false}
	true if an elapsed-time index is present.
bool	has_idx_url {false}
	true if a URL index is present.
bool	has_schema {false}
	true if any schemas are embedded.
int32_t	timezone {0}
	Timezone offset in minutes from UTC.
int64_t	start_timestamp {0}
	Recording start timestamp (milliseconds since epoch).
int64_t	blank_duration {0}
	Total blank (gap) duration (milliseconds).
int64_t	total_duration {0}
	Total recording duration (milliseconds).
int64_t	file_size {0}
	File size in bytes.
int64_t	total_raw_size {0}
	Total uncompressed payload size (bytes).
int64_t	message_count {0}
	Total number of messages across all URLs.
int64_t	split_count {0}
	Number of file splits (0 if single file).
int64_t	split_by_size {0}
	Split threshold by size (bytes).
int64_t	split_by_time {0}
	Split threshold by time (milliseconds).
std::vector< UrlMeta >	url_metas
	Per-URL statistics, one entry per recorded topic.

Detailed Description

Metadata extracted from the bag file header and index.

Available after construction. Contains file-level metadata and per-URL statistics.

Member Data Documentation

blank_duration

int64_t vlink::BagReader::Info::blank_duration {0}

Total blank (gap) duration (milliseconds).

compression_type

std::string vlink::BagReader::Info::compression_type

Compression algorithm used (e.g., "lzav", "zstd").

date_time

std::string vlink::BagReader::Info::date_time

Recording start date/time string.

file_name

std::string vlink::BagReader::Info::file_name

Absolute path to the bag file.

file_size

int64_t vlink::BagReader::Info::file_size {0}

File size in bytes.

has_completed

bool vlink::BagReader::Info::has_completed {false}

true if the recording was cleanly finalized.

has_idx_elapsed

bool vlink::BagReader::Info::has_idx_elapsed {false}

true if an elapsed-time index is present.

has_idx_url

bool vlink::BagReader::Info::has_idx_url {false}

true if a URL index is present.

has_schema

bool vlink::BagReader::Info::has_schema {false}

true if any schemas are embedded.

message_count

int64_t vlink::BagReader::Info::message_count {0}

Total number of messages across all URLs.

process_name

std::string vlink::BagReader::Info::process_name

Name of the recording process.

split_by_size

int64_t vlink::BagReader::Info::split_by_size {0}

Split threshold by size (bytes).

split_by_time

int64_t vlink::BagReader::Info::split_by_time {0}

Split threshold by time (milliseconds).

split_count

int64_t vlink::BagReader::Info::split_count {0}

Number of file splits (0 if single file).

start_timestamp

int64_t vlink::BagReader::Info::start_timestamp {0}

Recording start timestamp (milliseconds since epoch).

storage_type

std::string vlink::BagReader::Info::storage_type

Storage backend (e.g., "sqlite", "mcap").

tag_name

std::string vlink::BagReader::Info::tag_name

Tag name stored in the bag header.

time_accuracy

std::string vlink::BagReader::Info::time_accuracy

Timestamp resolution (e.g., "us", "ns").

timezone

int32_t vlink::BagReader::Info::timezone {0}

Timezone offset in minutes from UTC.

total_duration

int64_t vlink::BagReader::Info::total_duration {0}

Total recording duration (milliseconds).

total_raw_size

int64_t vlink::BagReader::Info::total_raw_size {0}

Total uncompressed payload size (bytes).

url_metas

std::vector<UrlMeta> vlink::BagReader::Info::url_metas

Per-URL statistics, one entry per recorded topic.

version

std::string vlink::BagReader::Info::version

Bag format version string.

---

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

• include/vlink/extension/bag_reader.h