measurements.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/measurements.def.rs".
 
#pragma once
 
#include "../collection.hpp"
#include "../component_batch.hpp"
#include "../component_column.hpp"
#include "../components/aggregation_policy.hpp"
#include "../components/color.hpp"
#include "../components/interpolation_mode.hpp"
#include "../components/name.hpp"
#include "../components/scalar.hpp"
#include "../components/stroke_width.hpp"
#include "../components/unit.hpp"
#include "../components/variance.hpp"
#include "../components/visible.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::archetypes {
    /// **Archetype**: One or more scalar measurements, each with a variance and a unit.
    ///
    /// Use this for sensors that report a value together with its uncertainty:
    /// pressure, temperature, illuminance, relative humidity, range, and so on.
    ///
    /// In a `views::TimeSeriesView` each series is drawn as a line with a translucent
    /// band around it, one standard deviation (the square root of the variance) wide in each direction.
    /// Leave `variances` unset if the uncertainty is unknown.
    ///
    /// The current timeline value is used for the time/X-axis, so measurements should not be
    /// static. Number of values per timestamp is expected to be the same over time.
    ///
    /// Unlike `archetypes::Scalars`, this archetype carries its own styling, so values and style
    /// are logged together.
    /// Changes over time are supported for most but not all styling fields (see respective fields for details).
    ///
    /// ## Example
    ///
    /// ### Pressure with variance
    /// ![image](https://static.rerun.io/measurements/2388490ab2b487bb6c47a2be3e7d5e7aa17c08f3/full.png)
    ///
    /// ```cpp
    /// #include <rerun.hpp>
    ///
    /// #include <cmath>
    ///
    /// int main(int argc, char* argv[]) {
    ///     const auto rec =
    ///         rerun::RecordingStream("rerun_example_measurements_simple");
    ///     rec.spawn().exit_on_failure();
    ///
    ///     // Two parallel pressure sensors (in Pa), each with slowly drifting variance.
    ///     for (int step = 0; step <64; ++step) {
    ///         rec.set_time_sequence("step", step);
    ///         const auto s = static_cast<double>(step);
    ///         const std::array<double, 2> pressures = {
    ///             101325.0 + 50.0 * std::sin(s / 10.0),
    ///             101300.0 + 30.0 * std::cos(s / 8.0),
    ///         };
    ///         const std::array<double, 2> variances = {
    ///             100.0 + 25.0 * std::sin(s / 7.0),
    ///             80.0 + 15.0 * std::cos(s / 11.0),
    ///         };
    ///         rec.log(
    ///             "pressure",
    ///             rerun::Measurements(pressures).with_variances(variances).with_units(
    ///                 {"Pa"}
    ///             )
    ///         );
    ///     }
    /// }
    /// ```
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct Measurements {
        /// The measured scalar values.
        std::optional<ComponentBatch> values;
 
        /// Variances of the measurements (σ², in the units of `values` squared).
        ///
        /// When set, length is expected to match `values`.
        std::optional<ComponentBatch> variances;
 
        /// Units of the measurements, shown in the legend and in tooltips.
        ///
        /// When set, length is expected to match `values`.
        /// Expected to be unchanging over time.
        std::optional<ComponentBatch> units;
 
        /// Color for the corresponding series.
        ///
        /// May change over time, but can cause discontinuities in the line.
        std::optional<ComponentBatch> colors;
 
        /// Stroke width for the corresponding series.
        ///
        /// May change over time, but can cause discontinuities in the line.
        std::optional<ComponentBatch> widths;
 
        /// Display name of the series.
        ///
        /// Used in the legend. Expected to be unchanging over time.
        std::optional<ComponentBatch> names;
 
        /// Which series are visible.
        ///
        /// If not set, all series on this entity are visible.
        /// Unlike with the regular visibility property of the entire entity, any series that is hidden
        /// via this property will still be visible in the legend.
        ///
        /// May change over time, but can cause discontinuities in the line.
        std::optional<ComponentBatch> visible_series;
 
        /// Configures the zoom-dependent scalar aggregation.
        ///
        /// This is done only if steps on the X axis go below a single pixel,
        /// i.e. a single pixel covers more than one tick worth of data. It can greatly improve performance
        /// (and readability) in such situations as it prevents overdraw.
        ///
        /// Expected to be unchanging over time.
        std::optional<ComponentBatch> aggregation_policy;
 
        /// Specifies how values between data points are interpolated.
        ///
        /// Defaults to linear interpolation. Use one of the `Step*` variants for a stepped (staircase) line.
        ///
        /// Expected to be unchanging over time.
        std::optional<ComponentBatch> interpolation_mode;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.archetypes.Measurements";
 
        /// `ComponentDescriptor` for the `values` field.
        static constexpr auto Descriptor_values = ComponentDescriptor(
            ArchetypeName, "Measurements:values", Loggable<rerun::components::Scalar>::ComponentType
        );
        /// `ComponentDescriptor` for the `variances` field.
        static constexpr auto Descriptor_variances = ComponentDescriptor(
            ArchetypeName, "Measurements:variances",
            Loggable<rerun::components::Variance>::ComponentType
        );
        /// `ComponentDescriptor` for the `units` field.
        static constexpr auto Descriptor_units = ComponentDescriptor(
            ArchetypeName, "Measurements:units", Loggable<rerun::components::Unit>::ComponentType
        );
        /// `ComponentDescriptor` for the `colors` field.
        static constexpr auto Descriptor_colors = ComponentDescriptor(
            ArchetypeName, "Measurements:colors", Loggable<rerun::components::Color>::ComponentType
        );
        /// `ComponentDescriptor` for the `widths` field.
        static constexpr auto Descriptor_widths = ComponentDescriptor(
            ArchetypeName, "Measurements:widths",
            Loggable<rerun::components::StrokeWidth>::ComponentType
        );
        /// `ComponentDescriptor` for the `names` field.
        static constexpr auto Descriptor_names = ComponentDescriptor(
            ArchetypeName, "Measurements:names", Loggable<rerun::components::Name>::ComponentType
        );
        /// `ComponentDescriptor` for the `visible_series` field.
        static constexpr auto Descriptor_visible_series = ComponentDescriptor(
            ArchetypeName, "Measurements:visible_series",
            Loggable<rerun::components::Visible>::ComponentType
        );
        /// `ComponentDescriptor` for the `aggregation_policy` field.
        static constexpr auto Descriptor_aggregation_policy = ComponentDescriptor(
            ArchetypeName, "Measurements:aggregation_policy",
            Loggable<rerun::components::AggregationPolicy>::ComponentType
        );
        /// `ComponentDescriptor` for the `interpolation_mode` field.
        static constexpr auto Descriptor_interpolation_mode = ComponentDescriptor(
            ArchetypeName, "Measurements:interpolation_mode",
            Loggable<rerun::components::InterpolationMode>::ComponentType
        );
 
      public:
        Measurements() = default;
        Measurements(Measurements&& other) = default;
        Measurements(const Measurements& other) = default;
        Measurements& operator=(const Measurements& other) = default;
        Measurements& operator=(Measurements&& other) = default;
 
        explicit Measurements(Collection<rerun::components::Scalar> _values)
            : values(ComponentBatch::from_loggable(std::move(_values), Descriptor_values)
                         .value_or_throw()) {}
 
        /// Update only some specific fields of a `Measurements`.
        static Measurements update_fields() {
            return Measurements();
        }
 
        /// Clear all the fields of a `Measurements`.
        static Measurements clear_fields();
 
        /// The measured scalar values.
        Measurements with_values(const Collection<rerun::components::Scalar>& _values) && {
            values = ComponentBatch::from_loggable(_values, Descriptor_values).value_or_throw();
            return std::move(*this);
        }
 
        /// Variances of the measurements (σ², in the units of `values` squared).
        ///
        /// When set, length is expected to match `values`.
        Measurements with_variances(const Collection<rerun::components::Variance>& _variances) && {
            variances =
                ComponentBatch::from_loggable(_variances, Descriptor_variances).value_or_throw();
            return std::move(*this);
        }
 
        /// Units of the measurements, shown in the legend and in tooltips.
        ///
        /// When set, length is expected to match `values`.
        /// Expected to be unchanging over time.
        Measurements with_units(const Collection<rerun::components::Unit>& _units) && {
            units = ComponentBatch::from_loggable(_units, Descriptor_units).value_or_throw();
            return std::move(*this);
        }
 
        /// Color for the corresponding series.
        ///
        /// May change over time, but can cause discontinuities in the line.
        Measurements with_colors(const Collection<rerun::components::Color>& _colors) && {
            colors = ComponentBatch::from_loggable(_colors, Descriptor_colors).value_or_throw();
            return std::move(*this);
        }
 
        /// Stroke width for the corresponding series.
        ///
        /// May change over time, but can cause discontinuities in the line.
        Measurements with_widths(const Collection<rerun::components::StrokeWidth>& _widths) && {
            widths = ComponentBatch::from_loggable(_widths, Descriptor_widths).value_or_throw();
            return std::move(*this);
        }
 
        /// Display name of the series.
        ///
        /// Used in the legend. Expected to be unchanging over time.
        Measurements with_names(const Collection<rerun::components::Name>& _names) && {
            names = ComponentBatch::from_loggable(_names, Descriptor_names).value_or_throw();
            return std::move(*this);
        }
 
        /// Which series are visible.
        ///
        /// If not set, all series on this entity are visible.
        /// Unlike with the regular visibility property of the entire entity, any series that is hidden
        /// via this property will still be visible in the legend.
        ///
        /// May change over time, but can cause discontinuities in the line.
        Measurements with_visible_series(
            const Collection<rerun::components::Visible>& _visible_series
        ) && {
            visible_series =
                ComponentBatch::from_loggable(_visible_series, Descriptor_visible_series)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// Configures the zoom-dependent scalar aggregation.
        ///
        /// This is done only if steps on the X axis go below a single pixel,
        /// i.e. a single pixel covers more than one tick worth of data. It can greatly improve performance
        /// (and readability) in such situations as it prevents overdraw.
        ///
        /// Expected to be unchanging over time.
        Measurements with_aggregation_policy(
            const rerun::components::AggregationPolicy& _aggregation_policy
        ) && {
            aggregation_policy =
                ComponentBatch::from_loggable(_aggregation_policy, Descriptor_aggregation_policy)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// This method makes it possible to pack multiple `aggregation_policy` in a single component batch.
        ///
        /// This only makes sense when used in conjunction with `columns`. `with_aggregation_policy` should
        /// be used when logging a single row's worth of data.
        Measurements with_many_aggregation_policy(
            const Collection<rerun::components::AggregationPolicy>& _aggregation_policy
        ) && {
            aggregation_policy =
                ComponentBatch::from_loggable(_aggregation_policy, Descriptor_aggregation_policy)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// Specifies how values between data points are interpolated.
        ///
        /// Defaults to linear interpolation. Use one of the `Step*` variants for a stepped (staircase) line.
        ///
        /// Expected to be unchanging over time.
        Measurements with_interpolation_mode(
            const rerun::components::InterpolationMode& _interpolation_mode
        ) && {
            interpolation_mode =
                ComponentBatch::from_loggable(_interpolation_mode, Descriptor_interpolation_mode)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// This method makes it possible to pack multiple `interpolation_mode` in a single component batch.
        ///
        /// This only makes sense when used in conjunction with `columns`. `with_interpolation_mode` should
        /// be used when logging a single row's worth of data.
        Measurements with_many_interpolation_mode(
            const Collection<rerun::components::InterpolationMode>& _interpolation_mode
        ) && {
            interpolation_mode =
                ComponentBatch::from_loggable(_interpolation_mode, Descriptor_interpolation_mode)
                    .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::Measurements> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const archetypes::Measurements& archetype
        );
    };
} // namespace rerun