Rerun C++ SDK
Loading...
Searching...
No Matches
column_display_mode.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/column_display_mode.def.rs".
3
4#pragma once
5
6#include "../../result.hpp"
7
8#include <cstdint>
9#include <memory>
10
11namespace arrow {
12 /// \private
13 template <typename T>
14 class NumericBuilder;
15
16 class Array;
17 class DataType;
18 class UInt8Type;
19 using UInt8Builder = NumericBuilder<UInt8Type>;
20} // namespace arrow
21
22namespace rerun::blueprint::components {
23 /// **Component**: How table column names are displayed when no explicit display name is configured.
24 ///
25 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
26 ///
27 enum class ColumnDisplayMode : uint8_t {
28
29 /// Humanized field name, e.g. `Start time`, with `rerun_` prefixes removed.
30 ///
31 /// Colliding names are expanded with humanized parent segments across all columns,
32 /// including hidden columns, until distinct or fully expanded.
33 Compact = 1,
34
35 /// Component name, e.g. `RecordingInfo:start_time`.
36 ///
37 /// Colliding names are expanded with physical parent segments across all columns,
38 /// including hidden columns, until distinct or fully expanded.
39 Component = 2,
40
41 /// Full physical name, e.g. `property:RecordingInfo:start_time`.
42 Full = 3,
43 };
44} // namespace rerun::blueprint::components
45
46namespace rerun {
47 template <typename T>
48 struct Loggable;
49
50 /// \private
51 template <>
52 struct Loggable<blueprint::components::ColumnDisplayMode> {
53 static constexpr std::string_view ComponentType =
54 "rerun.blueprint.components.ColumnDisplayMode";
55
56 /// Returns the arrow data type this type corresponds to.
57 static const std::shared_ptr<arrow::DataType>& arrow_data_type();
58
59 /// Serializes an array of `rerun::blueprint:: components::ColumnDisplayMode` into an arrow array.
60 static Result<std::shared_ptr<arrow::Array>> to_arrow(
61 const blueprint::components::ColumnDisplayMode* instances, size_t num_instances
62 );
63
64 /// Fills an arrow array builder with an array of this type.
65 static rerun::Error fill_arrow_array_builder(
66 arrow::UInt8Builder* builder, const blueprint::components::ColumnDisplayMode* elements,
67 size_t num_elements
68 );
69 };
70} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:104
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:26