rerun::archetypes::RecordingInfo Struct Reference

Archetype: A list of properties associated with a recording. More...

#include <rerun/archetypes/recording_info.hpp>

Public Member Functions
	RecordingInfo (RecordingInfo &&other)=default
	RecordingInfo (const RecordingInfo &other)=default
RecordingInfo &	operator= (const RecordingInfo &other)=default
RecordingInfo &	operator= (RecordingInfo &&other)=default
RecordingInfo	with_start_time (const rerun::components::Timestamp &_start_time) &&
	When the recording started.
RecordingInfo	with_many_start_time (const Collection< rerun::components::Timestamp > &_start_time) &&
	This method makes it possible to pack multiple start_time in a single component batch.
RecordingInfo	with_name (const rerun::components::Name &_name) &&
	A user-chosen name for the recording.
RecordingInfo	with_many_name (const Collection< rerun::components::Name > &_name) &&
	This method makes it possible to pack multiple name 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 RecordingInfo	update_fields ()
	Update only some specific fields of a RecordingInfo.
static RecordingInfo	clear_fields ()
	Clear all the fields of a RecordingInfo.

Public Attributes
std::optional< ComponentBatch >	start_time
	When the recording started.
std::optional< ComponentBatch >	name
	A user-chosen name for the recording.

Static Public Attributes
static constexpr const char	ArchetypeName [] = "rerun.archetypes.RecordingInfo"
	The name of the archetype as used in ComponentDescriptors.
static constexpr auto	Descriptor_start_time
	ComponentDescriptor for the start_time field.
static constexpr auto	Descriptor_name
	ComponentDescriptor for the name field.

Detailed Description

Archetype: A list of properties associated with a recording.

Member Function Documentation

with_start_time()

RecordingInfo rerun::archetypes::RecordingInfo::with_start_time ( const rerun::components::Timestamp &  _start_time ) &&

inline

When the recording started.

Should be an absolute time, i.e. relative to Unix Epoch.

with_many_start_time()

RecordingInfo rerun::archetypes::RecordingInfo::with_many_start_time ( const Collection< rerun::components::Timestamp > &  _start_time ) &&

inline

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

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

with_many_name()

RecordingInfo rerun::archetypes::RecordingInfo::with_many_name ( const Collection< rerun::components::Name > &  _name ) &&

inline

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

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

columns() [1/2]

Collection< ComponentColumn > rerun::archetypes::RecordingInfo::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::RecordingInfo::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

start_time

std::optional<ComponentBatch> rerun::archetypes::RecordingInfo::start_time

When the recording started.

Should be an absolute time, i.e. relative to Unix Epoch.

Descriptor_start_time

constexpr auto rerun::archetypes::RecordingInfo::Descriptor_start_time

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "RecordingInfo:start_time",
            Loggable<rerun::components::Timestamp>::ComponentType
        )

ComponentDescriptor for the start_time field.

Descriptor_name

constexpr auto rerun::archetypes::RecordingInfo::Descriptor_name

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "RecordingInfo:name", Loggable<rerun::components::Name>::ComponentType
        )

ComponentDescriptor for the name field.

---

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

• rerun/archetypes/recording_info.hpp