Class ReaderBase¶

Defined in File reader_base.h

Inheritance Relationships¶

Derived Type¶

public ouster::sdk::osf::ReaderClass Reader

Class Documentation¶

class ReaderBase¶

OSF Reader that simply reads sequentially messages from the OSF file.

Subclassed by ouster::sdk::osf::Reader

Public Functions

ReaderBase(std::unique_ptr<OsfFile> osf_file, error_handler_t error_handler = default_error_handler)¶

Creates reader from OSF file resource.

Parameters:

osf_file[in] The OsfFile object to use to read from.
error_handler[in] An optional callback that serves as an error handler.

bool has_message_idx() const¶

Whether OSF contains the message counts that are needed for ts_by_message_idx()

Message counts was added a bit later to the OSF core (ChunkInfo struct), so this function will be obsolete over time.

Returns:: Whether OSF contains the message counts that are needed for ts_by_message_idx()

bool has_timestamp_idx() const¶

Whether OSF contains the message timestamp index in the metadata necessary to quickly collate and jump to a specific message time.

“

Returns:: Whether OSF contains the message timestamp index

std::string metadata_id() const¶

Return the metadata id.

Returns:: The metadata id.

ts_t start_ts() const¶

Return the lowest timestamp in the ChunksIter.

Returns:: The lowest timestamp in the ChunksIter.

ts_t end_ts() const¶

Return the highest timestamp in the ChunksIter.

Returns:: The highest timestamp in the ChunksIter.

const MetadataStore &meta_store() const¶

Return all metadata entries as a MetadataStore.

Returns:: All of the metadata entries as a MetadataStore.

bool has_stream_info() const¶

If the chunks can be read by stream and in non-decreasing timestamp order.

Returns:: The chunks can be read by stream and timestamps are sane.

ouster::sdk::core::Version version() const¶

Get the OSF file format version.

Returns:: The OSF file format version of this file.

uint64_t size() const¶

Get the size of the OSF file.

Returns:: The size of the OSF file in bytes.

OsfFile &file() const¶

Get the underlying file object.

Returns:: The underlying file.

bool verify_chunk(OsfOffset offset, OsfBuffer &buf)¶

Checks the flatbuffers validity of a chunk by chunk offset.

Parameters:

offset[in] Specify the chunk to verify via offset.
buf[in] A buffer containing the chunk to verify.

Returns:

The validity of the chunk.