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_name_, std::optional< std::string_view > archetype_field_name_, std::string_view component_name_)
constexpr	ComponentDescriptor (const char *archetype_name_, const char *archetype_field_name_, const char *component_name_)
constexpr	ComponentDescriptor (std::string_view component_name_)
constexpr	ComponentDescriptor (const char *component_name_)
ComponentDescriptorHash	hashed () const
ComponentDescriptor	with_archetype_name (std::optional< std::string_view > archetype_name_) const
	Unconditionally sets archetype_name to the given one.
ComponentDescriptor	with_archetype_name (const char *archetype_name_) const
	Unconditionally sets archetype_name to the given one.
ComponentDescriptor	with_archetype_field_name (std::optional< std::string_view > archetype_field_name_) const
	Unconditionally sets archetype_field_name to the given one.
ComponentDescriptor	with_archetype_field_name (const char *archetype_field_name_) const
	Unconditionally sets archetype_field_name to the given one.
ComponentDescriptor	or_with_archetype_name (std::optional< std::string_view > archetype_name_) const
	Sets archetype_name to the given one iff it's not already set.
ComponentDescriptor	or_with_archetype_name (const char *archetype_name_) const
	Sets archetype_name to the given one iff it's not already set.
ComponentDescriptor	or_with_archetype_field_name (std::optional< std::string_view > archetype_field_name_) const
	Sets archetype_field_name to the given one iff it's not already set.
ComponentDescriptor	or_with_archetype_field_name (const char *archetype_field_name_) const
	Sets archetype_field_name to the given one iff it's not already set.

Public Attributes
std::optional< std::string_view >	archetype_name
	Optional name of the Archetype associated with this data.
std::optional< std::string_view >	archetype_field_name
	Optional name of the field within Archetype associated with this data.
std::string_view	component_name
	Semantic name associated with this data.

Detailed Description

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

Every component is uniquely identified by its ComponentDescriptor.

Member Data Documentation

archetype_name

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

Optional name of the Archetype associated with this data.

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

Example: rerun.archetypes.Points3D.

archetype_field_name

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

Optional name of the field within Archetype associated with this data.

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

Example: positions.

component_name

std::string_view rerun::ComponentDescriptor::component_name

Semantic name associated with this data.

This is fully implied by archetype_name and archetype_field, but included for semantic convenience.

Example: rerun.components.Position3D.

---

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

• rerun/component_descriptor.hpp