struct LinearMessageView

Declaration

struct LinearMessageView { /* full declaration omitted */ };

Description

An iterable view of Messages in an MCAP file.

Declared at: mcap/include/mcap/reader.hpp:826

Method Overview

• public LinearMessageView(mcap::McapReader & mcapReader, const mcap::ProblemCallback & onProblem)
• public LinearMessageView(mcap::McapReader & mcapReader, mcap::ByteOffset dataStart, mcap::ByteOffset dataEnd, mcap::Timestamp startingAt, mcap::Timestamp endingBefore, const mcap::ProblemCallback & onProblem)
• public LinearMessageView(mcap::McapReader & mcapReader, const mcap::ReadMessageOptions & options, mcap::ByteOffset dataStart, mcap::ByteOffset dataEnd, const mcap::ProblemCallback & onProblem)
• public LinearMessageView(const mcap::LinearMessageView &)
• public LinearMessageView(mcap::LinearMessageView &&)
• public mcap::LinearMessageView::Iterator begin()
• public mcap::LinearMessageView::Iterator end()
• public const mcap::Status & status() const

Methods

¶LinearMessageView(
    mcap::McapReader& mcapReader,
    const mcap::ProblemCallback& onProblem)

Declared at: mcap/include/mcap/reader.hpp:875

Parameters

mcap::McapReader& mcapReader

const mcap::ProblemCallback& onProblem

¶LinearMessageView(
    mcap::McapReader& mcapReader,
    mcap::ByteOffset dataStart,
    mcap::ByteOffset dataEnd,
    mcap::Timestamp startingAt,
    mcap::Timestamp endingBefore,
    const mcap::ProblemCallback& onProblem)

Declared at: mcap/include/mcap/reader.hpp:876

Parameters

mcap::McapReader& mcapReader

mcap::ByteOffset dataStart

mcap::ByteOffset dataEnd

mcap::Timestamp startingAt

mcap::Timestamp endingBefore

const mcap::ProblemCallback& onProblem

¶LinearMessageView(
    mcap::McapReader& mcapReader,
    const mcap::ReadMessageOptions& options,
    mcap::ByteOffset dataStart,
    mcap::ByteOffset dataEnd,
    const mcap::ProblemCallback& onProblem)

Declared at: mcap/include/mcap/reader.hpp:878

Parameters

mcap::McapReader& mcapReader

const mcap::ReadMessageOptions& options

mcap::ByteOffset dataStart

mcap::ByteOffset dataEnd

const mcap::ProblemCallback& onProblem

¶LinearMessageView(const mcap::LinearMessageView&)

Declared at: mcap/include/mcap/reader.hpp:881

Parameters

const mcap::LinearMessageView&

¶LinearMessageView(mcap::LinearMessageView&&)

Declared at: mcap/include/mcap/reader.hpp:883

Parameters

mcap::LinearMessageView&&

¶mcap::LinearMessageView::Iterator begin()

Declared at: mcap/include/mcap/reader.hpp:886

¶mcap::LinearMessageView::Iterator end()

Declared at: mcap/include/mcap/reader.hpp:887

¶const mcap::Status& status() const

Description

The first problem encountered by this view, or Success if there have been none.

This is `NotOpen` if readMessages() was called on a reader that was not open, or `InvalidMessageReadOptions` if the ReadMessageOptions were not valid. Otherwise it records the first problem encountered while iterating, such as a corrupt record or a message referencing a missing channel. The same problems are also delivered to the ProblemCallback, if one was supplied to readMessages(). Check this after iteration finishes to find out whether every message in the view was read successfully.

Declared at: mcap/include/mcap/reader.hpp:899