rerun::ComponentDescriptor Struct Reference

A ComponentDescriptor fully describes the semantics of a column of data. More...

#include <rerun/component_descriptor.hpp>

Public Member Functions
constexpr	ComponentDescriptor (std::optional< std::string_view > archetype_, std::string_view component_, std::optional< std::string_view > component_type_)
constexpr	ComponentDescriptor (const char *archetype_, const char *component_, const char *component_type_)
constexpr	ComponentDescriptor (std::string_view component_)
constexpr	ComponentDescriptor (const char *component_)
ComponentDescriptorHash	hashed () const
ComponentDescriptor	with_archetype (std::optional< std::string_view > archetype_) const
	Unconditionally sets archetype to the given one.
ComponentDescriptor	with_archetype (const char *archetype_) const
	Unconditionally sets archetype to the given one.
ComponentDescriptor	with_component_type (std::optional< std::string_view > component_type_) const
	Unconditionally sets component_type to the given one.
ComponentDescriptor	with_component_type (const char *component_type_) const
	Unconditionally sets component_type to the given one.
ComponentDescriptor	or_with_archetype (std::optional< std::string_view > archetype_) const
	Sets archetype to the given one iff it's not already set.
ComponentDescriptor	or_with_archetype (const char *archetype_) const
	Sets archetype to the given one iff it's not already set.
ComponentDescriptor	or_with_component_type (std::optional< std::string_view > component_type_) const
	Sets component_type to the given one iff it's not already set.
ComponentDescriptor	or_with_component_type (const char *component_type_) const
	Sets component_type to the given one iff it's not already set.

Public Attributes
std::optional< std::string_view >	archetype
	Optional name of the Archetype associated with this data.
std::string_view	component
	Uniquely identifies of the component associated with this data.
std::optional< std::string_view >	component_type
	Optional type information for this component.

Detailed Description

A ComponentDescriptor fully describes the semantics of a column of data.

Every component at a given entity path is uniquely identified by the component field of the descriptor. The archetype and component_type fields provide additional information about the semantics of the data.

Member Data Documentation

archetype

std::optional<std::string_view> rerun::ComponentDescriptor::archetype

Optional name of the Archetype associated with this data.

None if the data wasn't logged through an archetype.

Example: rerun.archetypes.Points3D.

component

std::string_view rerun::ComponentDescriptor::component

Uniquely identifies of the component associated with this data.

Example: Points3D:positions.

component_type

std::optional<std::string_view> rerun::ComponentDescriptor::component_type

Optional type information for this component.

Can be used to inform applications on how to interpret the data.

Example: rerun.components.Position3D.

---

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

• rerun/component_descriptor.hpp