Rerun C++ SDK
Loading...
Searching...
No Matches
included_content.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/included_content.fbs".
3
4#pragma once
5
6#include "../../component_descriptor.hpp"
7#include "../../datatypes/entity_path.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**: All the contents in the container.
17 ///
18 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
19 ///
21 /// List of the contents by `datatypes::EntityPath`.
22 ///
23 /// This must be a path in the blueprint store.
24 /// Typically structure as `<blueprint_registry>/<uuid>`.
26
27 public:
28 IncludedContent() = default;
29
30 IncludedContent(rerun::datatypes::EntityPath contents_) : contents(std::move(contents_)) {}
31
32 IncludedContent& operator=(rerun::datatypes::EntityPath contents_) {
33 contents = std::move(contents_);
34 return *this;
35 }
36
37 IncludedContent(std::string path_) : contents(std::move(path_)) {}
38
39 IncludedContent& operator=(std::string path_) {
40 contents = std::move(path_);
41 return *this;
42 }
43
44 /// Cast to the underlying EntityPath datatype
46 return contents;
47 }
48 };
49} // namespace rerun::blueprint::components
50
51namespace rerun {
52 static_assert(
54 );
55
56 /// \private
57 template <>
58 struct Loggable<blueprint::components::IncludedContent> {
59 static constexpr ComponentDescriptor Descriptor =
60 "rerun.blueprint.components.IncludedContent";
61
62 /// Returns the arrow data type this type corresponds to.
63 static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
65 }
66
67 /// Serializes an array of `rerun::blueprint:: components::IncludedContent` into an arrow array.
68 static Result<std::shared_ptr<arrow::Array>> to_arrow(
69 const blueprint::components::IncludedContent* instances, size_t num_instances
70 ) {
71 if (num_instances == 0) {
72 return Loggable<rerun::datatypes::EntityPath>::to_arrow(nullptr, 0);
73 } else if (instances == nullptr) {
74 return rerun::Error(
75 ErrorCode::UnexpectedNullArgument,
76 "Passed array instances is null when num_elements> 0."
77 );
78 } else {
79 return Loggable<rerun::datatypes::EntityPath>::to_arrow(
80 &instances->contents,
81 num_instances
82 );
83 }
84 }
85 };
86} // 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: All the contents in the container.
Definition included_content.hpp:20
rerun::datatypes::EntityPath contents
List of the contents by datatypes::EntityPath.
Definition included_content.hpp:25
Datatype: A path to an entity in the ChunkStore.
Definition entity_path.hpp:22