table_blueprint.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/build/re_type_definitions/rerun/blueprint/archetypes/table_blueprint.def.rs".
 
#pragma once
 
#include "../../blueprint/components/column_display_mode.hpp"
#include "../../blueprint/components/sort_by.hpp"
#include "../../blueprint/components/sql_filter_expression.hpp"
#include "../../blueprint/components/table_layout_kind.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**: Blueprint for configuring the styling of a table.
    ///
    /// The table blueprint as a whole is distributed across these entity paths:
    /// * `/table` for this archetype and `archetypes::PreviewsConfig`.
    /// * `/table/layouts/table` for `archetypes::TableLayout`.
    /// * `/table/layouts/table/columns/{column_name}` for table `archetypes::TableColumn` archetypes and per-column options such as `archetypes::TableColumnPreview`.
    /// * `/table/layouts/cards` for `archetypes::CardLayout`.
    /// * `/table/layouts/cards/fields/{column_name}` for card `archetypes::TableColumn` archetypes and per-field options such as `archetypes::TableColumnPreview`.
    /// * `/view/{view_id}` for preview `archetypes::ViewBlueprint` definitions.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct TableBlueprint {
        /// The currently selected layout.
        ///
        /// If unset, defaults to card layout if available.
        /// `Cards` falls back to table layout when no `archetypes::CardLayout` is configured.
        std::optional<ComponentBatch> layout;
 
        /// Formatting for column names in table and card layouts.
        ///
        /// Defaults to compact formatting when unset.
        /// Explicit column display names take precedence.
        std::optional<ComponentBatch> column_display_mode;
 
        /// Filters for the table's rows.
        ///
        /// A row in the table is only shown when *all* filters evaluate to true for it.
        /// Each filter only sees the values of a single row, so functions that combine rows, such as `sum` or `count`, are not allowed.
        /// Write one condition per filter instead of joining them with `AND`.
        ///
        /// Users cannot write SQL in the viewer.
        /// They add filters with "Filter" in a column header's menu, which only writes the forms below.
        /// The viewer shows these forms on a single column `"c"` as filters the user can edit.
        /// Any other expression shows as a `Custom "c" filter` chip, which the user can only remove and whose SQL only shows on hover:
        /// * Numbers: `"c" = 7`, `"c" <7`, `"c" <= 7`, `"c"> 7`, `"c">= 7`.
        ///   For a 32-bit float column, write the value as `CAST(0.1 AS REAL)`.
        /// * Strings: `"c" ILIKE '%text%'` for contains, `'text%'` for starts with, `'%text'` for ends with.
        ///   Put a backslash before a literal `%`, `_` or backslash, and follow the pattern with an ESCAPE clause that names a quoted backslash.
        /// * Booleans: `"c" = true`, `"c" = false`, and `"c" IS NULL` for a nullable column.
        /// * Timestamps: `"c" <TIMESTAMPTZ '2026-01-01T00:00:00Z'` for before, `>=` for after, and both joined with `AND` for between.
        ///   Relative ranges have the same shape, such as `"c">= now() - INTERVAL '24 hours' AND "c" <now()` for the last 24 hours,
        ///   or `"c">= date_trunc('day', now()) AND "c" <date_trunc('day', now()) + INTERVAL '1 day'` for today.
        ///   Use `'week'` with `INTERVAL '7 days'` for this week, and shift both bounds back for yesterday or last week.
        ///   For an `Int64` column of nanoseconds, use `to_timestamp_nanos("c")`.
        /// * Lists: any form above on `x` inside `any_match("c", x -> …)`, true when any element is.
        ///
        /// Wrapping a form in `(…) IS NOT TRUE` gives its opposite, such as not equal or does not contain.
        std::optional<ComponentBatch> filters;
 
        /// The column and direction the table's rows are sorted by.
        ///
        /// Rows keep the order of the data when unset.
        std::optional<ComponentBatch> sort_by;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.TableBlueprint";
 
        /// `ComponentDescriptor` for the `layout` field.
        static constexpr auto Descriptor_layout = ComponentDescriptor(
            ArchetypeName, "TableBlueprint:layout",
            Loggable<rerun::blueprint::components::TableLayoutKind>::ComponentType
        );
        /// `ComponentDescriptor` for the `column_display_mode` field.
        static constexpr auto Descriptor_column_display_mode = ComponentDescriptor(
            ArchetypeName, "TableBlueprint:column_display_mode",
            Loggable<rerun::blueprint::components::ColumnDisplayMode>::ComponentType
        );
        /// `ComponentDescriptor` for the `filters` field.
        static constexpr auto Descriptor_filters = ComponentDescriptor(
            ArchetypeName, "TableBlueprint:filters",
            Loggable<rerun::blueprint::components::SqlFilterExpression>::ComponentType
        );
        /// `ComponentDescriptor` for the `sort_by` field.
        static constexpr auto Descriptor_sort_by = ComponentDescriptor(
            ArchetypeName, "TableBlueprint:sort_by",
            Loggable<rerun::blueprint::components::SortBy>::ComponentType
        );
 
      public:
        TableBlueprint() = default;
        TableBlueprint(TableBlueprint&& other) = default;
        TableBlueprint(const TableBlueprint& other) = default;
        TableBlueprint& operator=(const TableBlueprint& other) = default;
        TableBlueprint& operator=(TableBlueprint&& other) = default;
 
        /// Update only some specific fields of a `TableBlueprint`.
        static TableBlueprint update_fields() {
            return TableBlueprint();
        }
 
        /// Clear all the fields of a `TableBlueprint`.
        static TableBlueprint clear_fields();
 
        /// The currently selected layout.
        ///
        /// If unset, defaults to card layout if available.
        /// `Cards` falls back to table layout when no `archetypes::CardLayout` is configured.
        TableBlueprint with_layout(const rerun::blueprint::components::TableLayoutKind& _layout
        ) && {
            layout = ComponentBatch::from_loggable(_layout, Descriptor_layout).value_or_throw();
            return std::move(*this);
        }
 
        /// Formatting for column names in table and card layouts.
        ///
        /// Defaults to compact formatting when unset.
        /// Explicit column display names take precedence.
        TableBlueprint with_column_display_mode(
            const rerun::blueprint::components::ColumnDisplayMode& _column_display_mode
        ) && {
            column_display_mode =
                ComponentBatch::from_loggable(_column_display_mode, Descriptor_column_display_mode)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// Filters for the table's rows.
        ///
        /// A row in the table is only shown when *all* filters evaluate to true for it.
        /// Each filter only sees the values of a single row, so functions that combine rows, such as `sum` or `count`, are not allowed.
        /// Write one condition per filter instead of joining them with `AND`.
        ///
        /// Users cannot write SQL in the viewer.
        /// They add filters with "Filter" in a column header's menu, which only writes the forms below.
        /// The viewer shows these forms on a single column `"c"` as filters the user can edit.
        /// Any other expression shows as a `Custom "c" filter` chip, which the user can only remove and whose SQL only shows on hover:
        /// * Numbers: `"c" = 7`, `"c" <7`, `"c" <= 7`, `"c"> 7`, `"c">= 7`.
        ///   For a 32-bit float column, write the value as `CAST(0.1 AS REAL)`.
        /// * Strings: `"c" ILIKE '%text%'` for contains, `'text%'` for starts with, `'%text'` for ends with.
        ///   Put a backslash before a literal `%`, `_` or backslash, and follow the pattern with an ESCAPE clause that names a quoted backslash.
        /// * Booleans: `"c" = true`, `"c" = false`, and `"c" IS NULL` for a nullable column.
        /// * Timestamps: `"c" <TIMESTAMPTZ '2026-01-01T00:00:00Z'` for before, `>=` for after, and both joined with `AND` for between.
        ///   Relative ranges have the same shape, such as `"c">= now() - INTERVAL '24 hours' AND "c" <now()` for the last 24 hours,
        ///   or `"c">= date_trunc('day', now()) AND "c" <date_trunc('day', now()) + INTERVAL '1 day'` for today.
        ///   Use `'week'` with `INTERVAL '7 days'` for this week, and shift both bounds back for yesterday or last week.
        ///   For an `Int64` column of nanoseconds, use `to_timestamp_nanos("c")`.
        /// * Lists: any form above on `x` inside `any_match("c", x -> …)`, true when any element is.
        ///
        /// Wrapping a form in `(…) IS NOT TRUE` gives its opposite, such as not equal or does not contain.
        TableBlueprint with_filters(
            const Collection<rerun::blueprint::components::SqlFilterExpression>& _filters
        ) && {
            filters = ComponentBatch::from_loggable(_filters, Descriptor_filters).value_or_throw();
            return std::move(*this);
        }
 
        /// The column and direction the table's rows are sorted by.
        ///
        /// Rows keep the order of the data when unset.
        TableBlueprint with_sort_by(const rerun::blueprint::components::SortBy& _sort_by) && {
            sort_by = ComponentBatch::from_loggable(_sort_by, Descriptor_sort_by).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::TableBlueprint> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const blueprint::archetypes::TableBlueprint& archetype
        );
    };
} // namespace rerun