rerun::ComponentBatch Struct Reference

Arrow-encoded data of a single batch components for a single entity. More...

#include <rerun/component_batch.hpp>

Public Member Functions
Error	to_c_ffi_struct (rr_component_batch &out_component_batch) const
	To rerun C API component batch.

Static Public Member Functions
template<typename T >
static Result< ComponentBatch >	from_loggable (const rerun::Collection< T > &components)
	Creates a new component batch from a collection of component instances.
template<typename T >
static Result< ComponentBatch >	from_loggable (const rerun::Collection< T > &components, const ComponentDescriptor &descriptor)
	Creates a new component batch from a collection of component instances.
template<typename T >
static Result< ComponentBatch >	from_loggable (const T &component)
	Creates a new component batch from a single component instance.
template<typename T >
static Result< ComponentBatch >	from_loggable (const T &component, const ComponentDescriptor &descriptor)
	Creates a new component batch from a single component instance.
template<typename T >
static Result< ComponentBatch >	from_loggable (const std::optional< T > &component)
	Creates a new data cell from a single optional component instance.
template<typename T >
static Result< ComponentBatch >	from_loggable (const std::optional< T > &component, const ComponentDescriptor &descriptor)
	Creates a new data cell from a single optional component instance.
template<typename T >
static Result< ComponentBatch >	from_loggable (const std::optional< rerun::Collection< T > > &components)
	Creates a new data cell from an optional collection of component instances.
template<typename T >
static Result< ComponentBatch >	from_loggable (const std::optional< rerun::Collection< T > > &components, const ComponentDescriptor &descriptor)
	Creates a new data cell from an optional collection of component instances.

Public Attributes
std::shared_ptr< arrow::Array >	array
	Arrow-encoded data of the component instances.
ComponentTypeHandle	component_type
	The type of the component instances in array.

Detailed Description

Arrow-encoded data of a single batch components for a single entity.

Note that this doesn't own datatype and component_name.

Member Function Documentation

from_loggable() [1/8]

template<typename T >

static Result< ComponentBatch > rerun::ComponentBatch::from_loggable ( const rerun::Collection< T > &  components )

inlinestatic

Creates a new component batch from a collection of component instances.

Automatically registers the component type the first time this type is encountered.

from_loggable() [2/8]

template<typename T >

static Result< ComponentBatch > rerun::ComponentBatch::from_loggable ( const rerun::Collection< T > &  components, const ComponentDescriptor &  descriptor  )

inlinestatic

Creates a new component batch from a collection of component instances.

Automatically registers the component type the first time this type is encountered.

TODO(#4257) should take a rerun::Collection instead of pointer and size.

from_loggable() [3/8]

template<typename T >

static Result< ComponentBatch > rerun::ComponentBatch::from_loggable ( const T &  component )

inlinestatic

Creates a new component batch from a single component instance.

Automatically registers the component type the first time this type is encountered.

from_loggable() [4/8]

template<typename T >

static Result< ComponentBatch > rerun::ComponentBatch::from_loggable ( const T &  component, const ComponentDescriptor &  descriptor  )

inlinestatic

Creates a new component batch from a single component instance.

Automatically registers the component type the first time this type is encountered.

from_loggable() [5/8]

template<typename T >

static Result< ComponentBatch > rerun::ComponentBatch::from_loggable ( const std::optional< T > &  component )

inlinestatic

Creates a new data cell from a single optional component instance.

None is represented as a data cell with 0 instances.

Automatically registers the component type the first time this type is encountered.

from_loggable() [6/8]

template<typename T >

static Result< ComponentBatch > rerun::ComponentBatch::from_loggable ( const std::optional< T > &  component, const ComponentDescriptor &  descriptor  )

inlinestatic

Creates a new data cell from a single optional component instance.

None is represented as a data cell with 0 instances.

Automatically registers the component type the first time this type is encountered.

from_loggable() [7/8]

template<typename T >

static Result< ComponentBatch > rerun::ComponentBatch::from_loggable ( const std::optional< rerun::Collection< T > > &  components )

inlinestatic

Creates a new data cell from an optional collection of component instances.

None is represented as a data cell with 0 instances.

Automatically registers the component type the first time this type is encountered.

from_loggable() [8/8]

template<typename T >

static Result< ComponentBatch > rerun::ComponentBatch::from_loggable ( const std::optional< rerun::Collection< T > > &  components, const ComponentDescriptor &  descriptor  )

inlinestatic

Creates a new data cell from an optional collection of component instances.

None is represented as a data cell with 0 instances.

Automatically registers the component type the first time this type is encountered.

to_c_ffi_struct()

Error rerun::ComponentBatch::to_c_ffi_struct

(

rr_component_batch &

out_component_batch

)

const

To rerun C API component batch.

The resulting rr_component_batch keeps the arrow::Array alive until it is released.

---

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

• rerun/component_batch.hpp