ORE Studio 0.0.4
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
session_reader Class Referencefinal

Reads and parses ORES session recording files. More...

#include <session_reader.hpp>

Collaboration diagram for session_reader:
Collaboration graph

Static Public Member Functions

static std::expected< session_data, comms::recording::session_file_errorread (const std::filesystem::path &file_path)
 Read a complete session file.
 
static std::expected< session_metadata, comms::recording::session_file_errorread_metadata (const std::filesystem::path &file_path)
 Read only the session metadata (header).
 

Detailed Description

Reads and parses ORES session recording files.

This class provides functionality to read session recording files created by the session_recorder and extract the contained frames and metadata for analysis.

Member Function Documentation

◆ read()

std::expected< session_data, session_file_error > read ( const std::filesystem::path &  file_path)
static

Read a complete session file.

Parameters
file_pathPath to the session recording file
Returns
Expected containing session data, or error

◆ read_metadata()

std::expected< session_metadata, session_file_error > read_metadata ( const std::filesystem::path &  file_path)
static

Read only the session metadata (header).

Useful for quickly inspecting a file without loading all frames.

Parameters
file_pathPath to the session recording file
Returns
Expected containing session metadata, or error