flag.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/components/flag.def.rs".
 
#pragma once
 
#include "../encodings/bool.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <memory>
 
namespace rerun::components {
    /// **Component**: Whether a record is flagged, e.g. for review.
    ///
    /// The Viewer shows it as a flag button.
    /// Table card layouts show the first flag field in the card header.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct Flag {
        rerun::encodings::Bool flagged;
 
      public:
        Flag() = default;
 
        Flag(rerun::encodings::Bool flagged_) : flagged(flagged_) {}
 
        Flag& operator=(rerun::encodings::Bool flagged_) {
            flagged = flagged_;
            return *this;
        }
 
        Flag(bool value_) : flagged(value_) {}
 
        Flag& operator=(bool value_) {
            flagged = value_;
            return *this;
        }
 
        /// Cast to the underlying Bool encoding
        operator rerun::encodings::Bool() const {
            return flagged;
        }
    };
} // namespace rerun::components
 
namespace rerun {
    static_assert(sizeof(rerun::encodings::Bool) == sizeof(components::Flag));
 
    /// \private
    template <>
    struct Loggable<components::Flag> {
        static constexpr std::string_view ComponentType = "rerun.components.Flag";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_data_type() {
            return Loggable<rerun::encodings::Bool>::arrow_data_type();
        }
 
        /// Serializes an array of `rerun::components::Flag` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const components::Flag* instances, size_t num_instances
        ) {
            if (num_instances == 0) {
                return Loggable<rerun::encodings::Bool>::to_arrow(nullptr, 0);
            } else if (instances == nullptr) {
                return rerun::Error(
                    ErrorCode::UnexpectedNullArgument,
                    "Passed array instances is null when num_elements> 0."
                );
            } else {
                return Loggable<rerun::encodings::Bool>::to_arrow(
                    &instances->flagged,
                    num_instances
                );
            }
        }
    };
} // namespace rerun