scalars.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/archetypes/scalars.def.rs".
 
#pragma once
 
#include "../archetype_utils.hpp"
#include "../collection.hpp"
#include "../component_batch.hpp"
#include "../component_column.hpp"
#include "../components/scalar.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::archetypes {
    /// **Archetype**: One or more double-precision scalar values, e.g. for use for time-series plots.
    ///
    /// The current timeline value will be used for the time/X-axis, hence scalars
    /// should not be static.
    /// Number of scalars per timestamp is expected to be the same over time.
    ///
    /// When used to produce a plot, this archetype is used to provide the data that
    /// is referenced by `archetypes::SeriesLines` or `archetypes::SeriesPoints`. You can do
    /// this by logging both archetypes to the same path, or alternatively configuring
    /// the plot-specific archetypes through the blueprint.
    ///
    /// Each scalar in a batch is plotted as its own series.
    /// To show only some of them, set `visible_series` of `archetypes::SeriesLines` or `archetypes::SeriesPoints`,
    /// or click series in the plot legend.
    ///
    /// ## Examples
    ///
    /// ### Update a scalar over time
    /// ![image](https://static.rerun.io/transform3d_column_updates/2b7ccfd29349b2b107fcf7eb8a1291a92cf1cafc/full.png)
    ///
    /// ```cpp
    /// #include <cmath>
    ///
    /// #include <rerun.hpp>
    ///
    /// int main(int argc, char* argv[]) {
    ///     const auto rec = rerun::RecordingStream("rerun_example_scalar_row_updates");
    ///     rec.spawn().exit_on_failure();
    ///
    ///     for (int step = 0; step <64; ++step) {
    ///         rec.set_time_sequence("step", step);
    ///         rec.log(
    ///             "scalars",
    ///             rerun::Scalars(sin(static_cast<double>(step) / 10.0))
    ///         );
    ///     }
    /// }
    /// ```
    ///
    /// ### Update a scalar over time, in a single operation
    /// ![image](https://static.rerun.io/transform3d_column_updates/2b7ccfd29349b2b107fcf7eb8a1291a92cf1cafc/full.png)
    ///
    /// ```cpp
    /// #include <cmath>
    /// #include <numeric>
    /// #include <vector>
    ///
    /// #include <rerun.hpp>
    ///
    /// int main(int argc, char* argv[]) {
    ///     const auto rec =
    ///         rerun::RecordingStream("rerun_example_scalar_column_updates");
    ///     rec.spawn().exit_on_failure();
    ///
    ///     // Native scalars & times.
    ///     std::vector<double> scalar_data(64);
    ///     for (size_t i = 0; i <64; ++i) {
    ///         scalar_data[i] = sin(static_cast<double>(i) / 10.0);
    ///     }
    ///     std::vector<int64_t> times(64);
    ///     std::iota(times.begin(), times.end(), 0);
    ///
    ///     // Serialize to columns and send.
    ///     rec.send_columns(
    ///         "scalars",
    ///         rerun::TimeColumn::from_sequence("step", std::move(times)),
    ///         rerun::Scalars(std::move(scalar_data)).columns()
    ///     );
    /// }
    /// ```
    struct Scalars {
        /// The scalar values to log.
        std::optional<ComponentBatch> scalars;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.archetypes.Scalars";
 
        /// `ComponentDescriptor` for the `scalars` field.
        static constexpr auto Descriptor_scalars = ComponentDescriptor(
            ArchetypeName, "Scalars:scalars", Loggable<rerun::components::Scalar>::ComponentType
        );
 
      public:
        Scalars() = default;
        Scalars(Scalars&& other) = default;
        Scalars(const Scalars& other) = default;
        Scalars& operator=(const Scalars& other) = default;
        Scalars& operator=(Scalars&& other) = default;
 
        explicit Scalars(Collection<rerun::components::Scalar> _scalars)
            : scalars(ComponentBatch::from_loggable(std::move(_scalars), Descriptor_scalars)
                          .value_or_throw()) {}
 
        /// Update only some specific fields of a `Scalars`.
        static Scalars update_fields() {
            return Scalars();
        }
 
        /// Clear all the fields of a `Scalars`.
        static Scalars clear_fields();
 
        /// The scalar values to log.
        Scalars with_scalars(const Collection<rerun::components::Scalar>& _scalars) && {
            scalars = ComponentBatch::from_loggable(_scalars, Descriptor_scalars).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_) {
            return detail::partition_batches({&scalars}, lengths_).value_or_throw();
        }
 
        /// 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() {
            return detail::partition_batches_of_unit_length({&scalars}).value_or_throw();
        }
    };
 
} // namespace rerun::archetypes
 
namespace rerun {
    /// \private
    template <typename T>
    struct AsComponents;
 
    /// \private
    template <>
    struct AsComponents<archetypes::Scalars> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(const archetypes::Scalars& archetype) {
            return detail::collect_batches({&archetype.scalars});
        }
    };
} // namespace rerun