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/store/re_types/definitions/rerun/blueprint/components/timeline_name.fbs".
3
4#pragma once
5
6#include "../../component_descriptor.hpp"
7#include "../../datatypes/utf8.hpp"
8#include "../../result.hpp"
9
10#include <cstdint>
11#include <memory>
12#include <string>
13#include <utility>
14
15namespace rerun::blueprint::components {
16 /// **Component**: A timeline identified by its name.
17 ///
18 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
19 ///
20 struct TimelineName {
22
23 public:
24 TimelineName() = default;
25
26 TimelineName(rerun::datatypes::Utf8 value_) : value(std::move(value_)) {}
27
28 TimelineName& operator=(rerun::datatypes::Utf8 value_) {
29 value = std::move(value_);
30 return *this;
31 }
32
33 TimelineName(std::string value_) : value(std::move(value_)) {}
34
35 TimelineName& operator=(std::string value_) {
36 value = std::move(value_);
37 return *this;
38 }
39
40 /// Cast to the underlying Utf8 datatype
41 operator rerun::datatypes::Utf8() const {
42 return value;
43 }
44 };
45} // namespace rerun::blueprint::components
46
47namespace rerun {
48 static_assert(sizeof(rerun::datatypes::Utf8) == sizeof(blueprint::components::TimelineName));
49
50 /// \private
51 template <>
52 struct Loggable<blueprint::components::TimelineName> {
53 static constexpr ComponentDescriptor Descriptor = "rerun.blueprint.components.TimelineName";
54
55 /// Returns the arrow data type this type corresponds to.
56 static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
58 }
59
60 /// Serializes an array of `rerun::blueprint:: components::TimelineName` into an arrow array.
61 static Result<std::shared_ptr<arrow::Array>> to_arrow(
62 const blueprint::components::TimelineName* instances, size_t num_instances
63 ) {
64 if (num_instances == 0) {
65 return Loggable<rerun::datatypes::Utf8>::to_arrow(nullptr, 0);
66 } else if (instances == nullptr) {
67 return rerun::Error(
68 ErrorCode::UnexpectedNullArgument,
69 "Passed array instances is null when num_elements> 0."
70 );
71 } else {
72 return Loggable<rerun::datatypes::Utf8>::to_arrow(&instances->value, num_instances);
73 }
74 }
75 };
76} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:99
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
A ComponentDescriptor fully describes the semantics of a column of data.
Definition component_descriptor.hpp:14
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:20
Datatype: A string of text, encoded as UTF-8.
Definition utf8.hpp:22