table_column.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_column.def.rs".
 
#pragma once
 
#include "../../blueprint/components/column_type.hpp"
#include "../../blueprint/components/editable.hpp"
#include "../../collection.hpp"
#include "../../component_batch.hpp"
#include "../../component_column.hpp"
#include "../../components/name.hpp"
#include "../../components/visible.hpp"
#include "../../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::blueprint::archetypes {
    /// **Archetype**: Blueprint for a column used by a table or card layout.
    ///
    /// This archetype is stored at the layout-specific path for its source column.
    /// The source is the final `components::ColumnName` part of that path.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct TableColumn {
        /// The name shown for the column.
        ///
        /// If unset, the name is inferred from the source column.
        std::optional<ComponentBatch> name;
 
        /// Whether the column's values can be edited.
        ///
        /// If unset, editing is disabled.
        /// Edits require a remote table with a column marked by `rerun:is_table_index` metadata and write permission.
        /// A column can only be edited when its component type has an editor in the Viewer.
        std::optional<ComponentBatch> editable;
 
        /// Whether the column is visible in this layout.
        ///
        /// If unset, the enclosing layout determines visibility.
        /// Columns listed in the enclosing layout's `column_order` or `field_order` are shown.
        /// Unlisted columns use the viewer default for table layouts and are hidden in card layouts.
        std::optional<ComponentBatch> visible;
 
        /// Overrides the component the column's values are shown as.
        ///
        /// This picks the component UI for every value of the column.
        /// The column's Arrow datatype must match the datatype of the component type.
        /// If unset, the component of the source column is used, or the Viewer infers one from the column's datatype.
        std::optional<ComponentBatch> column_type;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.TableColumn";
 
        /// `ComponentDescriptor` for the `name` field.
        static constexpr auto Descriptor_name = ComponentDescriptor(
            ArchetypeName, "TableColumn:name", Loggable<rerun::components::Name>::ComponentType
        );
        /// `ComponentDescriptor` for the `editable` field.
        static constexpr auto Descriptor_editable = ComponentDescriptor(
            ArchetypeName, "TableColumn:editable",
            Loggable<rerun::blueprint::components::Editable>::ComponentType
        );
        /// `ComponentDescriptor` for the `visible` field.
        static constexpr auto Descriptor_visible = ComponentDescriptor(
            ArchetypeName, "TableColumn:visible",
            Loggable<rerun::components::Visible>::ComponentType
        );
        /// `ComponentDescriptor` for the `column_type` field.
        static constexpr auto Descriptor_column_type = ComponentDescriptor(
            ArchetypeName, "TableColumn:column_type",
            Loggable<rerun::blueprint::components::ColumnType>::ComponentType
        );
 
      public:
        TableColumn() = default;
        TableColumn(TableColumn&& other) = default;
        TableColumn(const TableColumn& other) = default;
        TableColumn& operator=(const TableColumn& other) = default;
        TableColumn& operator=(TableColumn&& other) = default;
 
        /// Update only some specific fields of a `TableColumn`.
        static TableColumn update_fields() {
            return TableColumn();
        }
 
        /// Clear all the fields of a `TableColumn`.
        static TableColumn clear_fields();
 
        /// The name shown for the column.
        ///
        /// If unset, the name is inferred from the source column.
        TableColumn with_name(const rerun::components::Name& _name) && {
            name = ComponentBatch::from_loggable(_name, Descriptor_name).value_or_throw();
            return std::move(*this);
        }
 
        /// Whether the column's values can be edited.
        ///
        /// If unset, editing is disabled.
        /// Edits require a remote table with a column marked by `rerun:is_table_index` metadata and write permission.
        /// A column can only be edited when its component type has an editor in the Viewer.
        TableColumn with_editable(const rerun::blueprint::components::Editable& _editable) && {
            editable =
                ComponentBatch::from_loggable(_editable, Descriptor_editable).value_or_throw();
            return std::move(*this);
        }
 
        /// Whether the column is visible in this layout.
        ///
        /// If unset, the enclosing layout determines visibility.
        /// Columns listed in the enclosing layout's `column_order` or `field_order` are shown.
        /// Unlisted columns use the viewer default for table layouts and are hidden in card layouts.
        TableColumn with_visible(const rerun::components::Visible& _visible) && {
            visible = ComponentBatch::from_loggable(_visible, Descriptor_visible).value_or_throw();
            return std::move(*this);
        }
 
        /// Overrides the component the column's values are shown as.
        ///
        /// This picks the component UI for every value of the column.
        /// The column's Arrow datatype must match the datatype of the component type.
        /// If unset, the component of the source column is used, or the Viewer infers one from the column's datatype.
        TableColumn with_column_type(const rerun::blueprint::components::ColumnType& _column_type
        ) && {
            column_type = ComponentBatch::from_loggable(_column_type, Descriptor_column_type)
                              .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::TableColumn> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const blueprint::archetypes::TableColumn& archetype
        );
    };
} // namespace rerun