Rerun C++ SDK
Loading...
Searching...
No Matches
scalar.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/components/scalar.fbs".
3
4#pragma once
5
6#include "../component_descriptor.hpp"
7#include "../datatypes/float64.hpp"
8#include "../result.hpp"
9
10#include <cstdint>
11#include <memory>
12
13namespace rerun::components {
14 /// **Component**: A scalar value, encoded as a 64-bit floating point.
15 ///
16 /// Used for time series plots.
17 struct Scalar {
19
20 public:
21 Scalar() = default;
22
23 Scalar(rerun::datatypes::Float64 value_) : value(value_) {}
24
25 Scalar& operator=(rerun::datatypes::Float64 value_) {
26 value = value_;
27 return *this;
28 }
29
30 Scalar(double value_) : value(value_) {}
31
32 Scalar& operator=(double value_) {
33 value = value_;
34 return *this;
35 }
36
37 /// Cast to the underlying Float64 datatype
38 operator rerun::datatypes::Float64() const {
39 return value;
40 }
41 };
42} // namespace rerun::components
43
44namespace rerun {
45 static_assert(sizeof(rerun::datatypes::Float64) == sizeof(components::Scalar));
46
47 /// \private
48 template <>
49 struct Loggable<components::Scalar> {
50 static constexpr ComponentDescriptor Descriptor = "rerun.components.Scalar";
51
52 /// Returns the arrow data type this type corresponds to.
53 static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
54 return Loggable<rerun::datatypes::Float64>::arrow_datatype();
55 }
56
57 /// Serializes an array of `rerun::components::Scalar` into an arrow array.
58 static Result<std::shared_ptr<arrow::Array>> to_arrow(
59 const components::Scalar* instances, size_t num_instances
60 ) {
61 if (num_instances == 0) {
62 return Loggable<rerun::datatypes::Float64>::to_arrow(nullptr, 0);
63 } else if (instances == nullptr) {
64 return rerun::Error(
65 ErrorCode::UnexpectedNullArgument,
66 "Passed array instances is null when num_elements> 0."
67 );
68 } else {
69 return Loggable<rerun::datatypes::Float64>::to_arrow(
70 &instances->value,
71 num_instances
72 );
73 }
74 }
75 };
76} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:95
All built-in components. See Types in the Rerun manual.
Definition rerun.hpp:80
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
Component: A scalar value, encoded as a 64-bit floating point.
Definition scalar.hpp:17
Datatype: A double-precision 64-bit IEEE 754 floating point number.
Definition float64.hpp:25