Variant.h

Go to the documentation of this file.

/* Copyright (c) 2024, Bernardo Escalona
 *
 * This file is part of NanoOcp <https://github.com/ChristianAhrens/NanoOcp>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <cstdint>          //< USE std::uint8_t, std::uint16_t, std::uint32_t, std::uint64_t in GCC-13
#include <variant>          //< USE std::variant
#include <array>            //< USE std::array
#include "Ocp1DataTypes.h"  //< USE NanoOcp1::Ocp1DataType
 
 
namespace NanoOcp1
{
 
class Variant
{
public:
    Variant(bool v);
    Variant(std::int32_t v);
    Variant(std::uint8_t v);
    Variant(std::uint16_t v);
    Variant(std::uint32_t v);
    Variant(std::uint64_t v);
    Variant(std::float_t v);
    Variant(std::double_t v);
    Variant(const std::string& v);
    Variant(const char* v);
    Variant(std::float_t x, std::float_t y, std::float_t z);
 
    Variant() = default;
 
    Variant(const std::vector<std::uint8_t>& data, Ocp1DataType type = OCP1DATATYPE_BLOB);
 
    virtual ~Variant() = default;
 
    bool operator==(const Variant& other) const;
    bool operator!=(const Variant& other) const;
 
    bool IsValid() const;
 
    Ocp1DataType GetDataType() const;
 
    std::vector<std::uint8_t> ToParamData(Ocp1DataType type = OCP1DATATYPE_NONE, bool* pOk = nullptr) const;
 
    bool ToBool(bool* pOk = nullptr) const;
    std::int32_t ToInt32(bool* pOk = nullptr) const;
    std::uint8_t ToUInt8(bool* pOk = nullptr) const;
    std::uint16_t ToUInt16(bool* pOk = nullptr) const;
    std::uint32_t ToUInt32(bool* pOk = nullptr) const;
    std::uint64_t ToUInt64(bool* pOk = nullptr) const;
    std::float_t ToFloat(bool* pOk = nullptr) const;
    std::double_t ToDouble(bool* pOk = nullptr) const;
    std::string ToString(bool* pOk = nullptr) const;
 
    std::array<std::float_t, 3> ToPosition(bool* pOk = nullptr) const;
 
    std::string ToPositionString(bool* pOk = nullptr) const;
 
    std::array<std::float_t, 6> ToAimingAndPosition(bool* pOk = nullptr) const;
 
    [[deprecated("Use ToAimingAndPosition instead, this method will be removed in the future. "
      "NOTE: The output of both methods is identical, but the new method has a more consistent name.")]]
    std::array<std::float_t, 6> ToPositionAndRotation(bool* pOk = nullptr) const;
 
    std::string ToAimingAndPositionString(bool* pOk = nullptr) const;
 
    std::vector<bool> ToBoolVector(bool* pOk = nullptr) const;
 
    std::vector<std::string> ToStringVector(bool* pOk = nullptr) const;
 
 
protected:
    std::vector<std::uint8_t> ToByteVector(bool* pOk = nullptr) const;
 
    enum TypeIndex
    {
        TypeNone = 0,       
        TypeBool,           
        TypeInt32,          
        TypeUInt8,          
        TypeUInt16,         
        TypeUInt32,         
        TypeUInt64,         
        TypeFloat,          
        TypeDouble,         
        TypeString,         
        TypeByteVector      
    };
 
    using VariantType = std::variant<std::monostate,                // TypeNone
                                     bool,                          // TypeBool
                                     std::int32_t,                  // TypeInt32
                                     std::uint8_t,                  // TypeUInt8
                                     std::uint16_t,                 // TypeUInt16
                                     std::uint32_t,                 // TypeUInt32
                                     std::uint64_t,                 // TypeUInt64
                                     std::float_t,                  // TypeFloat
                                     std::double_t,                 // TypeDouble
                                     std::string,                   // TypeString
                                     std::vector<std::uint8_t>>;    // TypeByteVector
 
private:
    VariantType m_value; 
};
 
}