Rerun C++ SDK
Loading...
Searching...
No Matches
channel_id.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/channel_id.fbs".
3
4#pragma once
5
6#include "../datatypes/uint16.hpp"
7#include "../result.hpp"
8
9#include <cstdint>
10#include <memory>
11
12namespace rerun::components {
13 /// **Component**: A 16-bit ID representing an MCAP channel.
14 ///
15 /// Used to identify specific channels within an MCAP file.
16 struct ChannelId {
18
19 public:
20 ChannelId() = default;
21
22 ChannelId(rerun::datatypes::UInt16 id_) : id(id_) {}
23
24 ChannelId& operator=(rerun::datatypes::UInt16 id_) {
25 id = id_;
26 return *this;
27 }
28
29 ChannelId(uint16_t value_) : id(value_) {}
30
31 ChannelId& operator=(uint16_t value_) {
32 id = value_;
33 return *this;
34 }
35
36 /// Cast to the underlying UInt16 datatype
37 operator rerun::datatypes::UInt16() const {
38 return id;
39 }
40 };
41} // namespace rerun::components
42
43namespace rerun {
44 static_assert(sizeof(rerun::datatypes::UInt16) == sizeof(components::ChannelId));
45
46 /// \private
47 template <>
48 struct Loggable<components::ChannelId> {
49 static constexpr std::string_view ComponentType = "rerun.components.ChannelId";
50
51 /// Returns the arrow data type this type corresponds to.
52 static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
53 return Loggable<rerun::datatypes::UInt16>::arrow_datatype();
54 }
55
56 /// Serializes an array of `rerun::components::ChannelId` into an arrow array.
57 static Result<std::shared_ptr<arrow::Array>> to_arrow(
58 const components::ChannelId* instances, size_t num_instances
59 ) {
60 if (num_instances == 0) {
61 return Loggable<rerun::datatypes::UInt16>::to_arrow(nullptr, 0);
62 } else if (instances == nullptr) {
63 return rerun::Error(
64 ErrorCode::UnexpectedNullArgument,
65 "Passed array instances is null when num_elements> 0."
66 );
67 } else {
68 return Loggable<rerun::datatypes::UInt16>::to_arrow(&instances->id, num_instances);
69 }
70 }
71 };
72} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:103
All built-in components. See Types in the Rerun manual.
Definition rerun.hpp:79
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
Component: A 16-bit ID representing an MCAP channel.
Definition channel_id.hpp:16
Datatype: A 16bit unsigned integer.
Definition uint16.hpp:24