Rerun C++ SDK
Loading...
Searching...
No Matches
dataframe_query.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/archetypes/dataframe_query.fbs".
3
4#pragma once
5
6#include "../../blueprint/components/latest_at_queries.hpp"
7#include "../../blueprint/components/query_kind.hpp"
8#include "../../blueprint/components/time_range_queries.hpp"
9#include "../../blueprint/components/timeline_name.hpp"
10#include "../../collection.hpp"
11#include "../../compiler_utils.hpp"
12#include "../../component_batch.hpp"
13#include "../../indicator_component.hpp"
14#include "../../result.hpp"
15
16#include <cstdint>
17#include <optional>
18#include <utility>
19#include <vector>
20
21namespace rerun::blueprint::archetypes {
22 /// **Archetype**: The query for the dataframe view.
24 /// The timeline for this query.
25 ///
26 /// If unset, use the time panel's timeline and a latest-at query, ignoring all other components of this archetype.
27 std::optional<rerun::blueprint::components::TimelineName> timeline;
28
29 /// Kind of query: latest-at or range.
30 std::optional<rerun::blueprint::components::QueryKind> kind;
31
32 /// Configuration for latest-at queries.
33 ///
34 /// Note: configuration as saved on a per-timeline basis.
35 std::optional<rerun::blueprint::components::LatestAtQueries> latest_at_queries;
36
37 /// Configuration for the time range queries.
38 ///
39 /// Note: configuration as saved on a per-timeline basis.
40 std::optional<rerun::blueprint::components::TimeRangeQueries> time_range_queries;
41
42 public:
43 static constexpr const char IndicatorComponentName[] =
44 "rerun.blueprint.components.DataframeQueryIndicator";
45
46 /// Indicator component, used to identify the archetype when converting to a list of components.
48
49 public:
50 DataframeQuery() = default;
51 DataframeQuery(DataframeQuery&& other) = default;
52
53 /// The timeline for this query.
54 ///
55 /// If unset, use the time panel's timeline and a latest-at query, ignoring all other components of this archetype.
57 timeline = std::move(_timeline);
58 // See: https://github.com/rerun-io/rerun/issues/4027
59 RR_WITH_MAYBE_UNINITIALIZED_DISABLED(return std::move(*this);)
60 }
61
62 /// Kind of query: latest-at or range.
63 DataframeQuery with_kind(rerun::blueprint::components::QueryKind _kind) && {
64 kind = std::move(_kind);
65 // See: https://github.com/rerun-io/rerun/issues/4027
66 RR_WITH_MAYBE_UNINITIALIZED_DISABLED(return std::move(*this);)
67 }
68
69 /// Configuration for latest-at queries.
70 ///
71 /// Note: configuration as saved on a per-timeline basis.
74 ) && {
75 latest_at_queries = std::move(_latest_at_queries);
76 // See: https://github.com/rerun-io/rerun/issues/4027
77 RR_WITH_MAYBE_UNINITIALIZED_DISABLED(return std::move(*this);)
78 }
79
80 /// Configuration for the time range queries.
81 ///
82 /// Note: configuration as saved on a per-timeline basis.
85 ) && {
86 time_range_queries = std::move(_time_range_queries);
87 // See: https://github.com/rerun-io/rerun/issues/4027
88 RR_WITH_MAYBE_UNINITIALIZED_DISABLED(return std::move(*this);)
89 }
90 };
91
92} // namespace rerun::blueprint::archetypes
93
94namespace rerun {
95 /// \private
96 template <typename T>
97 struct AsComponents;
98
99 /// \private
100 template <>
101 struct AsComponents<blueprint::archetypes::DataframeQuery> {
102 /// Serialize all set component batches.
103 static Result<std::vector<ComponentBatch>> serialize(
105 );
106 };
107} // namespace rerun
A class for representing either a usable value, or an error.
Definition result.hpp:14
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:22
Archetype: The query for the dataframe view.
Definition dataframe_query.hpp:23
DataframeQuery with_timeline(rerun::blueprint::components::TimelineName _timeline) &&
The timeline for this query.
Definition dataframe_query.hpp:56
std::optional< rerun::blueprint::components::TimeRangeQueries > time_range_queries
Configuration for the time range queries.
Definition dataframe_query.hpp:40
std::optional< rerun::blueprint::components::QueryKind > kind
Kind of query: latest-at or range.
Definition dataframe_query.hpp:30
std::optional< rerun::blueprint::components::LatestAtQueries > latest_at_queries
Configuration for latest-at queries.
Definition dataframe_query.hpp:35
DataframeQuery with_kind(rerun::blueprint::components::QueryKind _kind) &&
Kind of query: latest-at or range.
Definition dataframe_query.hpp:63
DataframeQuery with_latest_at_queries(rerun::blueprint::components::LatestAtQueries _latest_at_queries) &&
Configuration for latest-at queries.
Definition dataframe_query.hpp:72
std::optional< rerun::blueprint::components::TimelineName > timeline
The timeline for this query.
Definition dataframe_query.hpp:27
DataframeQuery with_time_range_queries(rerun::blueprint::components::TimeRangeQueries _time_range_queries) &&
Configuration for the time range queries.
Definition dataframe_query.hpp:83
Component: Configuration for latest-at queries.
Definition latest_at_queries.hpp:24
Component: Configuration for time range queries.
Definition time_range_queries.hpp:24
Component: A timeline identified by its name.
Definition timeline_name.hpp:16
Indicator component used by archetypes when converting them to component lists.
Definition indicator_component.hpp:30