Archetype: Recording-level statistics about an MCAP file, logged as a part of archetypes::RecordingInfo. More...

#include <rerun/archetypes/mcap_statistics.hpp>

Public Member Functions
	McapStatistics (McapStatistics &&other)=default

	McapStatistics (const McapStatistics &other)=default

McapStatistics &	operator= (const McapStatistics &other)=default

McapStatistics &	operator= (McapStatistics &&other)=default

	McapStatistics (rerun::components::Count _message_count, rerun::components::Count _schema_count, rerun::components::Count _channel_count, rerun::components::Count _attachment_count, rerun::components::Count _metadata_count, rerun::components::Count _chunk_count, rerun::components::Timestamp _message_start_time, rerun::components::Timestamp _message_end_time)

McapStatistics	with_message_count (const rerun::components::Count &_message_count) &&
	Total number of data messages contained in the MCAP recording.

McapStatistics	with_many_message_count (const Collection< rerun::components::Count > &_message_count) &&
	This method makes it possible to pack multiple `message_count` in a single component batch.

McapStatistics	with_schema_count (const rerun::components::Count &_schema_count) &&
	Number of unique schema definitions in the recording.

McapStatistics	with_many_schema_count (const Collection< rerun::components::Count > &_schema_count) &&
	This method makes it possible to pack multiple `schema_count` in a single component batch.

McapStatistics	with_channel_count (const rerun::components::Count &_channel_count) &&
	Number of channels defined in the recording.

McapStatistics	with_many_channel_count (const Collection< rerun::components::Count > &_channel_count) &&
	This method makes it possible to pack multiple `channel_count` in a single component batch.

McapStatistics	with_attachment_count (const rerun::components::Count &_attachment_count) &&
	Number of file attachments embedded in the recording.

McapStatistics	with_many_attachment_count (const Collection< rerun::components::Count > &_attachment_count) &&
	This method makes it possible to pack multiple `attachment_count` in a single component batch.

McapStatistics	with_metadata_count (const rerun::components::Count &_metadata_count) &&
	Number of metadata records providing additional context about the recording.

McapStatistics	with_many_metadata_count (const Collection< rerun::components::Count > &_metadata_count) &&
	This method makes it possible to pack multiple `metadata_count` in a single component batch.

McapStatistics	with_chunk_count (const rerun::components::Count &_chunk_count) &&
	Number of data chunks used to organize messages in the file.

McapStatistics	with_many_chunk_count (const Collection< rerun::components::Count > &_chunk_count) &&
	This method makes it possible to pack multiple `chunk_count` in a single component batch.

McapStatistics	with_message_start_time (const rerun::components::Timestamp &_message_start_time) &&
	Timestamp of the earliest message in the recording.

McapStatistics	with_many_message_start_time (const Collection< rerun::components::Timestamp > &_message_start_time) &&
	This method makes it possible to pack multiple `message_start_time` in a single component batch.

McapStatistics	with_message_end_time (const rerun::components::Timestamp &_message_end_time) &&
	Timestamp of the latest message in the recording.

McapStatistics	with_many_message_end_time (const Collection< rerun::components::Timestamp > &_message_end_time) &&
	This method makes it possible to pack multiple `message_end_time` in a single component batch.

McapStatistics	with_channel_message_counts (const rerun::components::ChannelMessageCounts &_channel_message_counts) &&
	Detailed breakdown of message counts per channel.

McapStatistics	with_many_channel_message_counts (const Collection< rerun::components::ChannelMessageCounts > &_channel_message_counts) &&
	This method makes it possible to pack multiple `channel_message_counts` in a single component batch.

Collection< ComponentColumn >	columns (const Collection< uint32_t > &lengths_)
	Partitions the component data into multiple sub-batches.

Collection< ComponentColumn >	columns ()
	Partitions the component data into unit-length sub-batches.

Static Public Member Functions
static McapStatistics	update_fields ()
	Update only some specific fields of a `McapStatistics`.

static McapStatistics	clear_fields ()
	Clear all the fields of a `McapStatistics`.

Public Attributes
std::optional< ComponentBatch >	message_count
	Total number of data messages contained in the MCAP recording.

std::optional< ComponentBatch >	schema_count
	Number of unique schema definitions in the recording.

std::optional< ComponentBatch >	channel_count
	Number of channels defined in the recording.

std::optional< ComponentBatch >	attachment_count
	Number of file attachments embedded in the recording.

std::optional< ComponentBatch >	metadata_count
	Number of metadata records providing additional context about the recording.

std::optional< ComponentBatch >	chunk_count
	Number of data chunks used to organize messages in the file.

std::optional< ComponentBatch >	message_start_time
	Timestamp of the earliest message in the recording.

std::optional< ComponentBatch >	message_end_time
	Timestamp of the latest message in the recording.

std::optional< ComponentBatch >	channel_message_counts
	Detailed breakdown of message counts per channel.

Static Public Attributes
static constexpr const char	ArchetypeName [] = "rerun.archetypes.McapStatistics"
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_message_count
	`ComponentDescriptor` for the `message_count` field.

static constexpr auto	Descriptor_schema_count
	`ComponentDescriptor` for the `schema_count` field.

static constexpr auto	Descriptor_channel_count
	`ComponentDescriptor` for the `channel_count` field.

static constexpr auto	Descriptor_attachment_count
	`ComponentDescriptor` for the `attachment_count` field.

static constexpr auto	Descriptor_metadata_count
	`ComponentDescriptor` for the `metadata_count` field.

static constexpr auto	Descriptor_chunk_count
	`ComponentDescriptor` for the `chunk_count` field.

static constexpr auto	Descriptor_message_start_time
	`ComponentDescriptor` for the `message_start_time` field.

static constexpr auto	Descriptor_message_end_time
	`ComponentDescriptor` for the `message_end_time` field.

static constexpr auto	Descriptor_channel_message_counts
	`ComponentDescriptor` for the `channel_message_counts` field.

Detailed Description

Archetype: Recording-level statistics about an MCAP file, logged as a part of archetypes::RecordingInfo.

This archetype contains summary information about an entire MCAP recording, including counts of messages, schemas, channels, and other records, as well as timing information spanning the full recording duration. It is typically logged once per recording to provide an overview of the dataset's structure and content.

See also archetypes::McapChannel for individual channel definitions, archetypes::McapMessage for message content, archetypes::McapSchema for schema definitions, and the MCAP specification for complete format details.

⚠ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

Member Function Documentation

◆ with_message_count()

McapStatistics rerun::archetypes::McapStatistics::with_message_count ( const rerun::components::Count & _message_count ) &&

inline

Total number of data messages contained in the MCAP recording.

This count includes all timestamped data messages but excludes metadata records, schema definitions, and other non-message records.

◆ with_many_message_count()

McapStatistics rerun::archetypes::McapStatistics::with_many_message_count ( const Collection< rerun::components::Count > & _message_count ) &&

inline

This method makes it possible to pack multiple message_count in a single component batch.

This only makes sense when used in conjunction with columns. with_message_count should be used when logging a single row's worth of data.

◆ with_schema_count()

McapStatistics rerun::archetypes::McapStatistics::with_schema_count ( const rerun::components::Count & _schema_count ) &&

inline

Number of unique schema definitions in the recording.

Each schema defines the structure for one or more message types used by channels.

◆ with_many_schema_count()

McapStatistics rerun::archetypes::McapStatistics::with_many_schema_count ( const Collection< rerun::components::Count > & _schema_count ) &&

inline

This method makes it possible to pack multiple schema_count in a single component batch.

This only makes sense when used in conjunction with columns. with_schema_count should be used when logging a single row's worth of data.

◆ with_channel_count()

McapStatistics rerun::archetypes::McapStatistics::with_channel_count ( const rerun::components::Count & _channel_count ) &&

inline

Number of channels defined in the recording.

Each channel represents a unique topic and encoding combination for publishing messages.

◆ with_many_channel_count()

McapStatistics rerun::archetypes::McapStatistics::with_many_channel_count ( const Collection< rerun::components::Count > & _channel_count ) &&

inline

This method makes it possible to pack multiple channel_count in a single component batch.

This only makes sense when used in conjunction with columns. with_channel_count should be used when logging a single row's worth of data.

◆ with_attachment_count()

McapStatistics rerun::archetypes::McapStatistics::with_attachment_count ( const rerun::components::Count & _attachment_count ) &&

inline

Number of file attachments embedded in the recording.

Attachments can include calibration files, configuration data, or other auxiliary files.

◆ with_many_attachment_count()

McapStatistics rerun::archetypes::McapStatistics::with_many_attachment_count ( const Collection< rerun::components::Count > & _attachment_count ) &&

inline

This method makes it possible to pack multiple attachment_count in a single component batch.

This only makes sense when used in conjunction with columns. with_attachment_count should be used when logging a single row's worth of data.

◆ with_metadata_count()

McapStatistics rerun::archetypes::McapStatistics::with_metadata_count ( const rerun::components::Count & _metadata_count ) &&

inline

Number of metadata records providing additional context about the recording.

Metadata records contain key-value pairs with information about the recording environment, system configuration, or other contextual data.

◆ with_many_metadata_count()

McapStatistics rerun::archetypes::McapStatistics::with_many_metadata_count ( const Collection< rerun::components::Count > & _metadata_count ) &&

inline

This method makes it possible to pack multiple metadata_count in a single component batch.

This only makes sense when used in conjunction with columns. with_metadata_count should be used when logging a single row's worth of data.

◆ with_chunk_count()

McapStatistics rerun::archetypes::McapStatistics::with_chunk_count ( const rerun::components::Count & _chunk_count ) &&

inline

Number of data chunks used to organize messages in the file.

Chunks group related messages together for efficient storage and indexed access.

◆ with_many_chunk_count()

McapStatistics rerun::archetypes::McapStatistics::with_many_chunk_count ( const Collection< rerun::components::Count > & _chunk_count ) &&

inline

This method makes it possible to pack multiple chunk_count in a single component batch.

This only makes sense when used in conjunction with columns. with_chunk_count should be used when logging a single row's worth of data.

◆ with_message_start_time()

McapStatistics rerun::archetypes::McapStatistics::with_message_start_time ( const rerun::components::Timestamp & _message_start_time ) &&

inline

Timestamp of the earliest message in the recording.

This marks the beginning of the recorded data timeline.

◆ with_many_message_start_time()

McapStatistics rerun::archetypes::McapStatistics::with_many_message_start_time ( const Collection< rerun::components::Timestamp > & _message_start_time ) &&

inline

This method makes it possible to pack multiple message_start_time in a single component batch.

This only makes sense when used in conjunction with columns. with_message_start_time should be used when logging a single row's worth of data.

◆ with_message_end_time()

McapStatistics rerun::archetypes::McapStatistics::with_message_end_time ( const rerun::components::Timestamp & _message_end_time ) &&

inline

Timestamp of the latest message in the recording.

Together with message_start_time, this defines the total duration of the recording.

◆ with_many_message_end_time()

McapStatistics rerun::archetypes::McapStatistics::with_many_message_end_time ( const Collection< rerun::components::Timestamp > & _message_end_time ) &&

inline

This method makes it possible to pack multiple message_end_time in a single component batch.

This only makes sense when used in conjunction with columns. with_message_end_time should be used when logging a single row's worth of data.

◆ with_many_channel_message_counts()

McapStatistics rerun::archetypes::McapStatistics::with_many_channel_message_counts ( const Collection< rerun::components::ChannelMessageCounts > & _channel_message_counts ) &&

inline

This method makes it possible to pack multiple channel_message_counts in a single component batch.

This only makes sense when used in conjunction with columns. with_channel_message_counts should be used when logging a single row's worth of data.

◆ columns() [1/2]

Collection< ComponentColumn > rerun::archetypes::McapStatistics::columns ( const Collection< uint32_t > & lengths_ )

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing ComponentBatch data into ComponentColumns instead, via ComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

◆ columns() [2/2]

Collection< ComponentColumn > rerun::archetypes::McapStatistics::columns ( )

Partitions the component data into unit-length sub-batches.

This is semantically similar to calling columns with std::vector<uint32_t>(n, 1), where n is automatically guessed.

Member Data Documentation

◆ message_count

std::optional<ComponentBatch> rerun::archetypes::McapStatistics::message_count

Total number of data messages contained in the MCAP recording.

This count includes all timestamped data messages but excludes metadata records, schema definitions, and other non-message records.

◆ schema_count

std::optional<ComponentBatch> rerun::archetypes::McapStatistics::schema_count

Number of unique schema definitions in the recording.

Each schema defines the structure for one or more message types used by channels.

◆ channel_count

std::optional<ComponentBatch> rerun::archetypes::McapStatistics::channel_count

Number of channels defined in the recording.

Each channel represents a unique topic and encoding combination for publishing messages.

◆ attachment_count

std::optional<ComponentBatch> rerun::archetypes::McapStatistics::attachment_count

Number of file attachments embedded in the recording.

Attachments can include calibration files, configuration data, or other auxiliary files.

◆ metadata_count

std::optional<ComponentBatch> rerun::archetypes::McapStatistics::metadata_count

Number of metadata records providing additional context about the recording.

Metadata records contain key-value pairs with information about the recording environment, system configuration, or other contextual data.

◆ chunk_count

std::optional<ComponentBatch> rerun::archetypes::McapStatistics::chunk_count

Number of data chunks used to organize messages in the file.

Chunks group related messages together for efficient storage and indexed access.

◆ message_start_time

std::optional<ComponentBatch> rerun::archetypes::McapStatistics::message_start_time

Timestamp of the earliest message in the recording.

This marks the beginning of the recorded data timeline.

◆ message_end_time

std::optional<ComponentBatch> rerun::archetypes::McapStatistics::message_end_time

Timestamp of the latest message in the recording.

Together with message_start_time, this defines the total duration of the recording.

◆ Descriptor_message_count

constexpr auto rerun::archetypes::McapStatistics::Descriptor_message_count

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:message_count",
            Loggable<rerun::components::Count>::ComponentType
        )

ComponentDescriptor for the message_count field.

◆ Descriptor_schema_count

constexpr auto rerun::archetypes::McapStatistics::Descriptor_schema_count

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:schema_count",
            Loggable<rerun::components::Count>::ComponentType
        )

ComponentDescriptor for the schema_count field.

◆ Descriptor_channel_count

constexpr auto rerun::archetypes::McapStatistics::Descriptor_channel_count

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:channel_count",
            Loggable<rerun::components::Count>::ComponentType
        )

ComponentDescriptor for the channel_count field.

◆ Descriptor_attachment_count

constexpr auto rerun::archetypes::McapStatistics::Descriptor_attachment_count

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:attachment_count",
            Loggable<rerun::components::Count>::ComponentType
        )

ComponentDescriptor for the attachment_count field.

◆ Descriptor_metadata_count

constexpr auto rerun::archetypes::McapStatistics::Descriptor_metadata_count

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:metadata_count",
            Loggable<rerun::components::Count>::ComponentType
        )

ComponentDescriptor for the metadata_count field.

◆ Descriptor_chunk_count

constexpr auto rerun::archetypes::McapStatistics::Descriptor_chunk_count

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:chunk_count",
            Loggable<rerun::components::Count>::ComponentType
        )

ComponentDescriptor for the chunk_count field.

◆ Descriptor_message_start_time

constexpr auto rerun::archetypes::McapStatistics::Descriptor_message_start_time

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:message_start_time",
            Loggable<rerun::components::Timestamp>::ComponentType
        )

ComponentDescriptor for the message_start_time field.

◆ Descriptor_message_end_time

constexpr auto rerun::archetypes::McapStatistics::Descriptor_message_end_time

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:message_end_time",
            Loggable<rerun::components::Timestamp>::ComponentType
        )

ComponentDescriptor for the message_end_time field.

◆ Descriptor_channel_message_counts

constexpr auto rerun::archetypes::McapStatistics::Descriptor_channel_message_counts

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "McapStatistics:channel_message_counts",
            Loggable<rerun::components::ChannelMessageCounts>::ComponentType
        )

ComponentDescriptor for the channel_message_counts field.

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

rerun/archetypes/mcap_statistics.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ with_message_count()

◆ with_many_message_count()

◆ with_schema_count()

◆ with_many_schema_count()

◆ with_channel_count()

◆ with_many_channel_count()

◆ with_attachment_count()

◆ with_many_attachment_count()

◆ with_metadata_count()

◆ with_many_metadata_count()

◆ with_chunk_count()

◆ with_many_chunk_count()

◆ with_message_start_time()

◆ with_many_message_start_time()

◆ with_message_end_time()

◆ with_many_message_end_time()

◆ with_many_channel_message_counts()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ message_count

◆ schema_count

◆ channel_count

◆ attachment_count

◆ metadata_count

◆ chunk_count

◆ message_start_time

◆ message_end_time

◆ Descriptor_message_count

◆ Descriptor_schema_count

◆ Descriptor_channel_count

◆ Descriptor_attachment_count

◆ Descriptor_metadata_count

◆ Descriptor_chunk_count

◆ Descriptor_message_start_time

◆ Descriptor_message_end_time

◆ Descriptor_channel_message_counts