Rerun C++ SDK
Loading...
Searching...
No Matches
timeline_name.hpp
1// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
2// Based on "crates/build/re_type_definitions/rerun/blueprint/components/timeline_name.def.rs".
3
4#pragma once
5
6#include "../../encodings/utf8.hpp"
7#include "../../result.hpp"
8
9#include <cstdint>
10#include <memory>
11#include <string>
12#include <utility>
13
14namespace rerun::blueprint::components {
15 /// **Component**: A timeline identified by its name.
16 ///
17 /// The name is used both as an identifier and as a display label: it is what timelines are
18 /// keyed on, and also what the user reads.
19 ///
20 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
21 ///
22 struct TimelineName {
24
25 public:
26 TimelineName() = default;
27
28 TimelineName(rerun::encodings::Utf8 value_) : value(std::move(value_)) {}
29
30 TimelineName& operator=(rerun::encodings::Utf8 value_) {
31 value = std::move(value_);
32 return *this;
33 }
34
35 TimelineName(std::string value_) : value(std::move(value_)) {}
36
37 TimelineName& operator=(std::string value_) {
38 value = std::move(value_);
39 return *this;
40 }
41
42 /// Cast to the underlying Utf8 encoding
43 operator rerun::encodings::Utf8() const {
44 return value;
45 }
46 };
47} // namespace rerun::blueprint::components
48
49namespace rerun {
50 static_assert(sizeof(rerun::encodings::Utf8) == sizeof(blueprint::components::TimelineName));
51
52 /// \private
53 template <>
54 struct Loggable<blueprint::components::TimelineName> {
55 static constexpr std::string_view ComponentType = "rerun.blueprint.components.TimelineName";
56
57 /// Returns the arrow data type this type corresponds to.
58 static const std::shared_ptr<arrow::DataType>& arrow_data_type() {
60 }
61
62 /// Serializes an array of `rerun::blueprint:: components::TimelineName` into an arrow array.
63 static Result<std::shared_ptr<arrow::Array>> to_arrow(
64 const blueprint::components::TimelineName* instances, size_t num_instances
65 ) {
66 if (num_instances == 0) {
67 return Loggable<rerun::encodings::Utf8>::to_arrow(nullptr, 0);
68 } else if (instances == nullptr) {
69 return rerun::Error(
70 ErrorCode::UnexpectedNullArgument,
71 "Passed array instances is null when num_elements> 0."
72 );
73 } else {
74 return Loggable<rerun::encodings::Utf8>::to_arrow(&instances->value, num_instances);
75 }
76 }
77 };
78} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:103
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:26
A type of component that can be registered.
Definition component_type.hpp:19
The Loggable trait is used by all built-in implementation of rerun::AsComponents to serialize a colle...
Definition loggable.hpp:11
Component: A timeline identified by its name.
Definition timeline_name.hpp:22
Encoding: A string of text, encoded as UTF-8.
Definition utf8.hpp:21