rerun::archetypes::RecordingProperties Struct Reference

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

#include <rerun/archetypes/recording_properties.hpp>

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	RecordingProperties (RecordingProperties &&other)=default
	RecordingProperties (const RecordingProperties &other)=default
RecordingProperties &	operator= (const RecordingProperties &other)=default
RecordingProperties &	operator= (RecordingProperties &&other)=default
RecordingProperties	with_start_time (const rerun::components::Timestamp &_start_time) &&
	When the recording started.
RecordingProperties	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.
RecordingProperties	with_name (const rerun::components::Name &_name) &&
	A user-chosen name for the recording.
RecordingProperties	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 RecordingProperties	update_fields ()
	Update only some specific fields of a RecordingProperties.
static RecordingProperties	clear_fields ()
	Clear all the fields of a RecordingProperties.

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	IndicatorComponentName []
static constexpr const char	ArchetypeName [] = "rerun.archetypes.RecordingProperties"
	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()

RecordingProperties rerun::archetypes::RecordingProperties::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()

RecordingProperties rerun::archetypes::RecordingProperties::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()

RecordingProperties rerun::archetypes::RecordingProperties::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::RecordingProperties::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::RecordingProperties::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::RecordingProperties::start_time

When the recording started.

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

IndicatorComponentName

constexpr const char rerun::archetypes::RecordingProperties::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.components.RecordingPropertiesIndicator"

Descriptor_start_time

constexpr auto rerun::archetypes::RecordingProperties::Descriptor_start_time

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "start_time",
            Loggable<rerun::components::Timestamp>::Descriptor.component_name
        )

ComponentDescriptor for the start_time field.

Descriptor_name

constexpr auto rerun::archetypes::RecordingProperties::Descriptor_name

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "name", Loggable<rerun::components::Name>::Descriptor.component_name
        )

ComponentDescriptor for the name field.

---

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

• rerun/archetypes/recording_properties.hpp