status.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/archetypes/status.fbs".
 
#pragma once
 
#include "../collection.hpp"
#include "../component_batch.hpp"
#include "../component_column.hpp"
#include "../components/text.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::archetypes {
    /// **Archetype**: A status update, representing a change in the status of an entity.
    ///
    /// Useful for representing discrete state machines, mode transitions, or
    /// status changes over time. Each logged `archetypes::Status` marks a new status
    /// at the given time. A `null` status is ignored by the Status view.
    ///
    /// The Status view displays these as horizontal colored lanes over time.
    ///
    /// ## Example
    ///
    /// ### Status changes over time
    /// ![image](https://static.rerun.io/status/8f224c6e4a9cbbb4b1e279c56a426ec4c6bfca50/full.png)
    ///
    /// ```cpp
    /// #include <rerun.hpp>
    ///
    /// int main(int argc, char* argv[]) {
    ///     const auto rec = rerun::RecordingStream("rerun_example_status");
    ///     rec.spawn().exit_on_failure();
    ///
    ///     rec.set_time_sequence("step", 0);
    ///     rec.log("door", rerun::Status().with_status("open"));
    ///
    ///     rec.set_time_sequence("step", 1);
    ///     rec.log("door", rerun::Status().with_status("closed"));
    ///
    ///     rec.set_time_sequence("step", 2);
    ///     rec.log("door", rerun::Status().with_status("open"));
    /// }
    /// ```
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct Status {
        /// The new status value. A `null` status is ignored, it can be used to partially update a multi-instance status array.
        std::optional<ComponentBatch> status;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.archetypes.Status";
 
        /// `ComponentDescriptor` for the `status` field.
        static constexpr auto Descriptor_status = ComponentDescriptor(
            ArchetypeName, "Status:status", Loggable<rerun::components::Text>::ComponentType
        );
 
      public:
        Status() = default;
        Status(Status&& other) = default;
        Status(const Status& other) = default;
        Status& operator=(const Status& other) = default;
        Status& operator=(Status&& other) = default;
 
        /// Update only some specific fields of a `Status`.
        static Status update_fields() {
            return Status();
        }
 
        /// Clear all the fields of a `Status`.
        static Status clear_fields();
 
        /// The new status value. A `null` status is ignored, it can be used to partially update a multi-instance status array.
        Status with_status(const rerun::components::Text& _status) && {
            status = ComponentBatch::from_loggable(_status, Descriptor_status).value_or_throw();
            return std::move(*this);
        }
 
        /// This method makes it possible to pack multiple `status` in a single component batch.
        ///
        /// This only makes sense when used in conjunction with `columns`. `with_status` should
        /// be used when logging a single row's worth of data.
        Status with_many_status(const Collection<rerun::components::Text>& _status) && {
            status = ComponentBatch::from_loggable(_status, Descriptor_status).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::archetypes
 
namespace rerun {
    /// \private
    template <typename T>
    struct AsComponents;
 
    /// \private
    template <>
    struct AsComponents<archetypes::Status> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(const archetypes::Status& archetype);
    };
} // namespace rerun