dataframe_query.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/store/re_sdk_types/definitions/rerun/blueprint/archetypes/dataframe_query.fbs".
 
#pragma once
 
#include "../../blueprint/components/apply_latest_at.hpp"
#include "../../blueprint/components/auto_scroll.hpp"
#include "../../blueprint/components/column_order.hpp"
#include "../../blueprint/components/filter_by_range.hpp"
#include "../../blueprint/components/filter_is_not_null.hpp"
#include "../../blueprint/components/selected_columns.hpp"
#include "../../blueprint/components/timeline_name.hpp"
#include "../../collection.hpp"
#include "../../component_batch.hpp"
#include "../../component_column.hpp"
#include "../../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::blueprint::archetypes {
    /// **Archetype**: The query for the dataframe view.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct DataframeQuery {
        /// The timeline for this query.
        ///
        /// If unset, the timeline currently active on the time panel is used.
        std::optional<ComponentBatch> timeline;
 
        /// If provided, only rows whose timestamp is within this range will be shown.
        ///
        /// Note: will be unset as soon as `timeline` is changed.
        std::optional<ComponentBatch> filter_by_range;
 
        /// If provided, only show rows which contains a logged event for the specified component.
        std::optional<ComponentBatch> filter_is_not_null;
 
        /// Should empty cells be filled with latest-at queries?
        std::optional<ComponentBatch> apply_latest_at;
 
        /// Selected columns. If unset, all columns are selected.
        std::optional<ComponentBatch> select;
 
        /// The order of entity path column groups. If unset, the default order is used.
        ///
        /// This affects the order of component columns, which are always grouped by entity path. Timeline columns always
        /// come first. Entities not listed here are appended at the end in default order.
        ///
        /// If `entity_order` contains any entity path that is not included in the view, they are ignored.
        std::optional<ComponentBatch> entity_order;
 
        /// Whether to auto-scroll to track the time cursor.
        ///
        /// When enabled and the view's timeline matches the time panel's active timeline,
        /// the view will scroll to keep the row at or before the current time cursor visible.
        std::optional<ComponentBatch> auto_scroll;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.DataframeQuery";
 
        /// `ComponentDescriptor` for the `timeline` field.
        static constexpr auto Descriptor_timeline = ComponentDescriptor(
            ArchetypeName, "DataframeQuery:timeline",
            Loggable<rerun::blueprint::components::TimelineName>::ComponentType
        );
        /// `ComponentDescriptor` for the `filter_by_range` field.
        static constexpr auto Descriptor_filter_by_range = ComponentDescriptor(
            ArchetypeName, "DataframeQuery:filter_by_range",
            Loggable<rerun::blueprint::components::FilterByRange>::ComponentType
        );
        /// `ComponentDescriptor` for the `filter_is_not_null` field.
        static constexpr auto Descriptor_filter_is_not_null = ComponentDescriptor(
            ArchetypeName, "DataframeQuery:filter_is_not_null",
            Loggable<rerun::blueprint::components::FilterIsNotNull>::ComponentType
        );
        /// `ComponentDescriptor` for the `apply_latest_at` field.
        static constexpr auto Descriptor_apply_latest_at = ComponentDescriptor(
            ArchetypeName, "DataframeQuery:apply_latest_at",
            Loggable<rerun::blueprint::components::ApplyLatestAt>::ComponentType
        );
        /// `ComponentDescriptor` for the `select` field.
        static constexpr auto Descriptor_select = ComponentDescriptor(
            ArchetypeName, "DataframeQuery:select",
            Loggable<rerun::blueprint::components::SelectedColumns>::ComponentType
        );
        /// `ComponentDescriptor` for the `entity_order` field.
        static constexpr auto Descriptor_entity_order = ComponentDescriptor(
            ArchetypeName, "DataframeQuery:entity_order",
            Loggable<rerun::blueprint::components::ColumnOrder>::ComponentType
        );
        /// `ComponentDescriptor` for the `auto_scroll` field.
        static constexpr auto Descriptor_auto_scroll = ComponentDescriptor(
            ArchetypeName, "DataframeQuery:auto_scroll",
            Loggable<rerun::blueprint::components::AutoScroll>::ComponentType
        );
 
      public:
        DataframeQuery() = default;
        DataframeQuery(DataframeQuery&& other) = default;
        DataframeQuery(const DataframeQuery& other) = default;
        DataframeQuery& operator=(const DataframeQuery& other) = default;
        DataframeQuery& operator=(DataframeQuery&& other) = default;
 
        /// Update only some specific fields of a `DataframeQuery`.
        static DataframeQuery update_fields() {
            return DataframeQuery();
        }
 
        /// Clear all the fields of a `DataframeQuery`.
        static DataframeQuery clear_fields();
 
        /// The timeline for this query.
        ///
        /// If unset, the timeline currently active on the time panel is used.
        DataframeQuery with_timeline(const rerun::blueprint::components::TimelineName& _timeline
        ) && {
            timeline =
                ComponentBatch::from_loggable(_timeline, Descriptor_timeline).value_or_throw();
            return std::move(*this);
        }
 
        /// If provided, only rows whose timestamp is within this range will be shown.
        ///
        /// Note: will be unset as soon as `timeline` is changed.
        DataframeQuery with_filter_by_range(
            const rerun::blueprint::components::FilterByRange& _filter_by_range
        ) && {
            filter_by_range =
                ComponentBatch::from_loggable(_filter_by_range, Descriptor_filter_by_range)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// If provided, only show rows which contains a logged event for the specified component.
        DataframeQuery with_filter_is_not_null(
            const rerun::blueprint::components::FilterIsNotNull& _filter_is_not_null
        ) && {
            filter_is_not_null =
                ComponentBatch::from_loggable(_filter_is_not_null, Descriptor_filter_is_not_null)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// Should empty cells be filled with latest-at queries?
        DataframeQuery with_apply_latest_at(
            const rerun::blueprint::components::ApplyLatestAt& _apply_latest_at
        ) && {
            apply_latest_at =
                ComponentBatch::from_loggable(_apply_latest_at, Descriptor_apply_latest_at)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// Selected columns. If unset, all columns are selected.
        DataframeQuery with_select(const rerun::blueprint::components::SelectedColumns& _select
        ) && {
            select = ComponentBatch::from_loggable(_select, Descriptor_select).value_or_throw();
            return std::move(*this);
        }
 
        /// The order of entity path column groups. If unset, the default order is used.
        ///
        /// This affects the order of component columns, which are always grouped by entity path. Timeline columns always
        /// come first. Entities not listed here are appended at the end in default order.
        ///
        /// If `entity_order` contains any entity path that is not included in the view, they are ignored.
        DataframeQuery with_entity_order(
            const rerun::blueprint::components::ColumnOrder& _entity_order
        ) && {
            entity_order = ComponentBatch::from_loggable(_entity_order, Descriptor_entity_order)
                               .value_or_throw();
            return std::move(*this);
        }
 
        /// Whether to auto-scroll to track the time cursor.
        ///
        /// When enabled and the view's timeline matches the time panel's active timeline,
        /// the view will scroll to keep the row at or before the current time cursor visible.
        DataframeQuery with_auto_scroll(const rerun::blueprint::components::AutoScroll& _auto_scroll
        ) && {
            auto_scroll = ComponentBatch::from_loggable(_auto_scroll, Descriptor_auto_scroll)
                              .value_or_throw();
            return std::move(*this);
        }
 
        /// Partitions the component data into multiple sub-batches.
        ///
        /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
        /// instead, via `ComponentBatch::partitioned`.
        ///
        /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
        ///
        /// The specified `lengths` must sum to the total length of the component batch.
        Collection<ComponentColumn> columns(const Collection<uint32_t>& lengths_);
 
        /// Partitions the component data into unit-length sub-batches.
        ///
        /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
        /// where `n` is automatically guessed.
        Collection<ComponentColumn> columns();
    };
 
} // namespace rerun::blueprint::archetypes
 
namespace rerun {
    /// \private
    template <typename T>
    struct AsComponents;
 
    /// \private
    template <>
    struct AsComponents<blueprint::archetypes::DataframeQuery> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const blueprint::archetypes::DataframeQuery& archetype
        );
    };
} // namespace rerun