CameraInfo.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2025 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include <array>
#include <chrono>
#include <cmath>
#include <ctime>
#include <iomanip>
#include <memory>
#include <set>
#include <sstream>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
 
#include "Zivid/DataModel/Detail/Detail.h"
#include "Zivid/DataModel/NodeType.h"
#include "Zivid/DataModel/Traits.h"
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/Detail/TypeTraits.h"
#include "Zivid/Range.h"
 
#ifdef _MSC_VER
#    pragma warning(push)
#    pragma warning(disable : 4251) // "X needs to have dll-interface to be used by clients of class Y."
#endif
 
namespace Zivid
{

 
    // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
    class ZIVID_CORE_EXPORT CameraInfo
    {
    public:
        static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;

        static constexpr const char *path{ "" };

        static constexpr const char *name{ "CameraInfo" };

        static constexpr const char *description{
            R"description(Information about camera model, serial number etc.)description"
        };
 
        static constexpr size_t version{ 7 };
 
#ifndef NO_DOC
        template<size_t>
        struct Version;
 
        using LatestVersion = Zivid::CameraInfo;
 
        // Short identifier. This value is not guaranteed to be universally unique
        // Todo(ZIVID-2808): Move this to internal DataModelExt header
        static constexpr std::array<uint8_t, 3> binaryId{ 'n', 'f', 'o' };
 
#endif

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT FirmwareVersion
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "FirmwareVersion" };

            static constexpr const char *name{ "FirmwareVersion" };

            static constexpr const char *description{ R"description(The firmware version on the camera)description" };

            using ValueType = std::string;

            static constexpr Range<ValueType::size_type> validSize()
            {
                return { 0, 256 };
            }

            FirmwareVersion() = default;

            explicit FirmwareVersion(std::string value)
                : m_value{ verifyValue(std::move(value)) }
            {}

            const std::string &value() const;

            std::string toString() const;

            bool operator==(const FirmwareVersion &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const FirmwareVersion &other) const
            {
                return m_value != other.m_value;
            }

            bool operator<(const FirmwareVersion &other) const
            {
                return m_value < other.m_value;
            }

            bool operator>(const FirmwareVersion &other) const
            {
                return m_value > other.m_value;
            }

            bool operator<=(const FirmwareVersion &other) const
            {
                return m_value <= other.m_value;
            }

            bool operator>=(const FirmwareVersion &other) const
            {
                return m_value >= other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const FirmwareVersion &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            ValueType static verifyValue(ValueType &&value)
            {
                return validSize().isInRange(value.size())
                           ? std::move(value)
                           : throw std::invalid_argument{ "Invalid FirmwareVersion size=" + std::to_string(value.size())
                                                          + ", valid size is {'max': 256}" };
            }
 
            std::string m_value{};
 
            friend struct DataModel::Detail::Befriend<FirmwareVersion>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT HardwareRevision
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "HardwareRevision" };

            static constexpr const char *name{ "HardwareRevision" };

            static constexpr const char *description{
                R"description(Hardware revision of this camera. This corresponds to the revision string that is printed on the product
label.
)description"
            };

            using ValueType = std::string;

            static constexpr Range<ValueType::size_type> validSize()
            {
                return { 0, 256 };
            }

            HardwareRevision() = default;

            explicit HardwareRevision(std::string value)
                : m_value{ verifyValue(std::move(value)) }
            {}

            const std::string &value() const;

            std::string toString() const;

            bool operator==(const HardwareRevision &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const HardwareRevision &other) const
            {
                return m_value != other.m_value;
            }

            bool operator<(const HardwareRevision &other) const
            {
                return m_value < other.m_value;
            }

            bool operator>(const HardwareRevision &other) const
            {
                return m_value > other.m_value;
            }

            bool operator<=(const HardwareRevision &other) const
            {
                return m_value <= other.m_value;
            }

            bool operator>=(const HardwareRevision &other) const
            {
                return m_value >= other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const HardwareRevision &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            ValueType static verifyValue(ValueType &&value)
            {
                return validSize().isInRange(value.size())
                           ? std::move(value)
                           : throw std::invalid_argument{ "Invalid HardwareRevision size="
                                                          + std::to_string(value.size())
                                                          + ", valid size is {'max': 256}" };
            }
 
            std::string m_value{};
 
            friend struct DataModel::Detail::Befriend<HardwareRevision>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT Model
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "Model" };

            static constexpr const char *name{ "Model" };

            static constexpr const char *description{ R"description(The model of the camera)description" };

            enum class ValueType
            {
                zividOnePlusSmall,
                zividOnePlusMedium,
                zividOnePlusLarge,
                zividTwo,
                zividTwoL100,
                zivid2PlusM130,
                zivid2PlusM60,
                zivid2PlusL110,
                zivid2PlusMR130,
                zivid2PlusMR60,
                zivid2PlusLR110,
                zivid3XL250
            };
            static const Model zividOnePlusSmall;  
            static const Model zividOnePlusMedium; 
            static const Model zividOnePlusLarge;  
            static const Model zividTwo;           
            static const Model zividTwoL100;       
            static const Model zivid2PlusM130;     
            static const Model zivid2PlusM60;      
            static const Model zivid2PlusL110;     
            static const Model zivid2PlusMR130;    
            static const Model zivid2PlusMR60;     
            static const Model zivid2PlusLR110;    
            static const Model zivid3XL250;        

            static std::set<ValueType> validValues()
            {
                return { ValueType::zividOnePlusSmall, ValueType::zividOnePlusMedium, ValueType::zividOnePlusLarge,
                         ValueType::zividTwo,          ValueType::zividTwoL100,       ValueType::zivid2PlusM130,
                         ValueType::zivid2PlusM60,     ValueType::zivid2PlusL110,     ValueType::zivid2PlusMR130,
                         ValueType::zivid2PlusMR60,    ValueType::zivid2PlusLR110,    ValueType::zivid3XL250 };
            }

            Model() = default;

            explicit constexpr Model(ValueType value)
                : m_value{ verifyValue(value) }
            {}

            ValueType value() const;

            std::string toString() const;

            friend std::ostream &operator<<(std::ostream &stream, const Model::ValueType &value)
            {
                return stream << Model{ value }.toString();
            }

            bool operator==(const Model &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const Model &other) const
            {
                return m_value != other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const Model &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            constexpr ValueType static verifyValue(const ValueType &value)
            {
                return value == ValueType::zividOnePlusSmall || value == ValueType::zividOnePlusMedium
                               || value == ValueType::zividOnePlusLarge || value == ValueType::zividTwo
                               || value == ValueType::zividTwoL100 || value == ValueType::zivid2PlusM130
                               || value == ValueType::zivid2PlusM60 || value == ValueType::zivid2PlusL110
                               || value == ValueType::zivid2PlusMR130 || value == ValueType::zivid2PlusMR60
                               || value == ValueType::zivid2PlusLR110 || value == ValueType::zivid3XL250
                           ? value
                           : throw std::invalid_argument{
                                 "Invalid value: Model{ "
                                 + std::to_string(static_cast<std::underlying_type<ValueType>::type>(value)) + " }"
                             };
            }
 
            ValueType m_value{ ValueType::zividOnePlusSmall };
 
            friend struct DataModel::Detail::Befriend<Model>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT ModelName
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "ModelName" };

            static constexpr const char *name{ "ModelName" };

            static constexpr const char *description{
                R"description(The model name of the camera. This is a user-friendly display name that may contain spaces and special
characters. We recommend to use `Model` instead if you want to programmatically check for camera model.
)description"
            };

            using ValueType = std::string;

            static constexpr Range<ValueType::size_type> validSize()
            {
                return { 0, 256 };
            }

            ModelName() = default;

            explicit ModelName(std::string value)
                : m_value{ verifyValue(std::move(value)) }
            {}

            const std::string &value() const;

            std::string toString() const;

            bool operator==(const ModelName &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const ModelName &other) const
            {
                return m_value != other.m_value;
            }

            bool operator<(const ModelName &other) const
            {
                return m_value < other.m_value;
            }

            bool operator>(const ModelName &other) const
            {
                return m_value > other.m_value;
            }

            bool operator<=(const ModelName &other) const
            {
                return m_value <= other.m_value;
            }

            bool operator>=(const ModelName &other) const
            {
                return m_value >= other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const ModelName &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            ValueType static verifyValue(ValueType &&value)
            {
                return validSize().isInRange(value.size())
                           ? std::move(value)
                           : throw std::invalid_argument{ "Invalid ModelName size=" + std::to_string(value.size())
                                                          + ", valid size is {'max': 256}" };
            }
 
            std::string m_value{};
 
            friend struct DataModel::Detail::Befriend<ModelName>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT Revision
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;

            static constexpr const char *path{ "Revision" };

            static constexpr const char *name{ "Revision" };

            static constexpr const char *description{
                R"description(Major/Minor hardware revision number. This field is deprecated and may be removed in a future version
of the SDK. Please use HardwareRevision instead.
)description"
            };

 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT Major
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

                static constexpr const char *path{ "Revision/Major" };

                static constexpr const char *name{ "Major" };

                static constexpr const char *description{
                    R"description(Major hardware revision number. This field is deprecated and may be removed in a future version
of the SDK. Please use HardwareRevision instead.
)description"
                };

                using ValueType = uint32_t;

                static constexpr Range<uint32_t> validRange()
                {
                    return { std::numeric_limits<uint32_t>::lowest(), std::numeric_limits<uint32_t>::max() };
                }

                Major() = default;

                explicit constexpr Major(uint32_t value)
                    : m_value{ value }
                {}

                uint32_t value() const;

                std::string toString() const;

                bool operator==(const Major &other) const
                {
                    return m_value == other.m_value;
                }

                bool operator!=(const Major &other) const
                {
                    return m_value != other.m_value;
                }

                bool operator<(const Major &other) const
                {
                    return m_value < other.m_value;
                }

                bool operator>(const Major &other) const
                {
                    return m_value > other.m_value;
                }

                bool operator<=(const Major &other) const
                {
                    return m_value <= other.m_value;
                }

                bool operator>=(const Major &other) const
                {
                    return m_value >= other.m_value;
                }

                friend std::ostream &operator<<(std::ostream &stream, const Major &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                uint32_t m_value{ 0 };
 
                friend struct DataModel::Detail::Befriend<Major>;
            };

 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT Minor
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

                static constexpr const char *path{ "Revision/Minor" };

                static constexpr const char *name{ "Minor" };

                static constexpr const char *description{
                    R"description(Minor hardware revision number. This field is deprecated and may be removed in a future version
of the SDK. Please use HardwareRevision instead.
)description"
                };

                using ValueType = uint32_t;

                static constexpr Range<uint32_t> validRange()
                {
                    return { std::numeric_limits<uint32_t>::lowest(), std::numeric_limits<uint32_t>::max() };
                }

                Minor() = default;

                explicit constexpr Minor(uint32_t value)
                    : m_value{ value }
                {}

                uint32_t value() const;

                std::string toString() const;

                bool operator==(const Minor &other) const
                {
                    return m_value == other.m_value;
                }

                bool operator!=(const Minor &other) const
                {
                    return m_value != other.m_value;
                }

                bool operator<(const Minor &other) const
                {
                    return m_value < other.m_value;
                }

                bool operator>(const Minor &other) const
                {
                    return m_value > other.m_value;
                }

                bool operator<=(const Minor &other) const
                {
                    return m_value <= other.m_value;
                }

                bool operator>=(const Minor &other) const
                {
                    return m_value >= other.m_value;
                }

                friend std::ostream &operator<<(std::ostream &stream, const Minor &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                uint32_t m_value{ 0 };
 
                friend struct DataModel::Detail::Befriend<Minor>;
            };
 
            using Descendants = std::tuple<CameraInfo::Revision::Major, CameraInfo::Revision::Minor>;

            Revision();

#ifndef NO_DOC
            template<
                typename... Args,
                typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0,
                typename std::enable_if<
                    Zivid::Detail::TypeTraits::AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>::
                        value,
                    int>::type = 0>
#else
            template<typename... Args>
#endif
            explicit Revision(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to Revision(...). "
                    "Types should be listed at most once.");
 
                set(std::forward<Args>(args)...);
            }

#ifndef NO_DOC
            template<typename... Args, typename std::enable_if<sizeof...(Args) >= 2, int>::type = 0>
#else
            template<typename... Args>
#endif
            void set(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
                static_assert(
                    AllArgsAreDescendantNodes::value, "All arguments passed to set(...) must be descendant nodes.");
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to set(...). "
                    "Types should be listed at most once.");
 
                Zivid::DataModel::Detail::invokeSetWithEachArgument(*this, std::forward<Args>(args)...);
            }

#ifndef NO_DOC
            template<typename... Args, typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0>
#else
            template<typename... Args>
#endif
            Revision copyWith(Args &&...args) const
            {
                using namespace Zivid::Detail::TypeTraits;
 
                using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
                static_assert(
                    AllArgsAreDescendantNodes::value,
                    "All arguments passed to copyWith(...) must be descendant nodes.");
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to copyWith(...). "
                    "Types should be listed at most once.");
 
                auto copy{ *this };
                copy.set(std::forward<Args>(args)...);
                return copy;
            }

            const Major &major() const
            {
                return m_major;
            }

            Major &major()
            {
                return m_major;
            }

            Revision &set(const Major &value)
            {
                m_major = value;
                return *this;
            }

            const Minor &minor() const
            {
                return m_minor;
            }

            Minor &minor()
            {
                return m_minor;
            }

            Revision &set(const Minor &value)
            {
                m_minor = value;
                return *this;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraInfo::Revision::Major>::value, int>::type = 0>
            const CameraInfo::Revision::Major &get() const
            {
                return m_major;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraInfo::Revision::Minor>::value, int>::type = 0>
            const CameraInfo::Revision::Minor &get() const
            {
                return m_minor;
            }
 
            template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
            const CameraInfo::Revision::Major &get() const
            {
                return m_major;
            }
 
            template<size_t i, typename std::enable_if<i == 1, int>::type = 0>
            const CameraInfo::Revision::Minor &get() const
            {
                return m_minor;
            }

            template<typename F>
            void forEach(const F &f) const
            {
                f(m_major);
                f(m_minor);
            }

            template<typename F>
            void forEach(const F &f)
            {
                f(m_major);
                f(m_minor);
            }

            bool operator==(const Revision &other) const;

            bool operator!=(const Revision &other) const;

            std::string toString() const;

            friend std::ostream &operator<<(std::ostream &stream, const Revision &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            void setFromString(const std::string &fullPath, const std::string &value);
 
            std::string getString(const std::string &fullPath) const;
 
            Major m_major;
            Minor m_minor;
 
            friend struct DataModel::Detail::Befriend<Revision>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT SerialNumber
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "SerialNumber" };

            static constexpr const char *name{ "SerialNumber" };

            static constexpr const char *description{ R"description(The serial number of the camera)description" };

            using ValueType = std::string;

            static constexpr Range<ValueType::size_type> validSize()
            {
                return { 0, 256 };
            }

            SerialNumber() = default;

            explicit SerialNumber(std::string value)
                : m_value{ verifyValue(std::move(value)) }
            {}

            const std::string &value() const;

            std::string toString() const;

            bool operator==(const SerialNumber &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const SerialNumber &other) const
            {
                return m_value != other.m_value;
            }

            bool operator<(const SerialNumber &other) const
            {
                return m_value < other.m_value;
            }

            bool operator>(const SerialNumber &other) const
            {
                return m_value > other.m_value;
            }

            bool operator<=(const SerialNumber &other) const
            {
                return m_value <= other.m_value;
            }

            bool operator>=(const SerialNumber &other) const
            {
                return m_value >= other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const SerialNumber &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            ValueType static verifyValue(ValueType &&value)
            {
                return validSize().isInRange(value.size())
                           ? std::move(value)
                           : throw std::invalid_argument{ "Invalid SerialNumber size=" + std::to_string(value.size())
                                                          + ", valid size is {'max': 256}" };
            }
 
            std::string m_value{};
 
            friend struct DataModel::Detail::Befriend<SerialNumber>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT UserData
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;

            static constexpr const char *path{ "UserData" };

            static constexpr const char *name{ "UserData" };

            static constexpr const char *description{
                R"description(Information about user data capabilities of the camera)description"
            };

 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT MaxSizeBytes
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

                static constexpr const char *path{ "UserData/MaxSizeBytes" };

                static constexpr const char *name{ "MaxSizeBytes" };

                static constexpr const char *description{
                    R"description(The maximum number of bytes of user data that can be stored in the camera)description"
                };

                using ValueType = uint64_t;

                static constexpr Range<uint64_t> validRange()
                {
                    return { std::numeric_limits<uint64_t>::lowest(), std::numeric_limits<uint64_t>::max() };
                }

                MaxSizeBytes() = default;

                explicit constexpr MaxSizeBytes(uint64_t value)
                    : m_value{ value }
                {}

                uint64_t value() const;

                std::string toString() const;

                bool operator==(const MaxSizeBytes &other) const
                {
                    return m_value == other.m_value;
                }

                bool operator!=(const MaxSizeBytes &other) const
                {
                    return m_value != other.m_value;
                }

                bool operator<(const MaxSizeBytes &other) const
                {
                    return m_value < other.m_value;
                }

                bool operator>(const MaxSizeBytes &other) const
                {
                    return m_value > other.m_value;
                }

                bool operator<=(const MaxSizeBytes &other) const
                {
                    return m_value <= other.m_value;
                }

                bool operator>=(const MaxSizeBytes &other) const
                {
                    return m_value >= other.m_value;
                }

                friend std::ostream &operator<<(std::ostream &stream, const MaxSizeBytes &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                uint64_t m_value{ 0 };
 
                friend struct DataModel::Detail::Befriend<MaxSizeBytes>;
            };
 
            using Descendants = std::tuple<CameraInfo::UserData::MaxSizeBytes>;

            UserData();

#ifndef NO_DOC
            template<
                typename... Args,
                typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0,
                typename std::enable_if<
                    Zivid::Detail::TypeTraits::AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>::
                        value,
                    int>::type = 0>
#else
            template<typename... Args>
#endif
            explicit UserData(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to UserData(...). "
                    "Types should be listed at most once.");
 
                set(std::forward<Args>(args)...);
            }

#ifndef NO_DOC
            template<typename... Args, typename std::enable_if<sizeof...(Args) >= 2, int>::type = 0>
#else
            template<typename... Args>
#endif
            void set(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
                static_assert(
                    AllArgsAreDescendantNodes::value, "All arguments passed to set(...) must be descendant nodes.");
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to set(...). "
                    "Types should be listed at most once.");
 
                Zivid::DataModel::Detail::invokeSetWithEachArgument(*this, std::forward<Args>(args)...);
            }

#ifndef NO_DOC
            template<typename... Args, typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0>
#else
            template<typename... Args>
#endif
            UserData copyWith(Args &&...args) const
            {
                using namespace Zivid::Detail::TypeTraits;
 
                using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
                static_assert(
                    AllArgsAreDescendantNodes::value,
                    "All arguments passed to copyWith(...) must be descendant nodes.");
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to copyWith(...). "
                    "Types should be listed at most once.");
 
                auto copy{ *this };
                copy.set(std::forward<Args>(args)...);
                return copy;
            }

            const MaxSizeBytes &maxSizeBytes() const
            {
                return m_maxSizeBytes;
            }

            MaxSizeBytes &maxSizeBytes()
            {
                return m_maxSizeBytes;
            }

            UserData &set(const MaxSizeBytes &value)
            {
                m_maxSizeBytes = value;
                return *this;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraInfo::UserData::MaxSizeBytes>::value, int>::type = 0>
            const CameraInfo::UserData::MaxSizeBytes &get() const
            {
                return m_maxSizeBytes;
            }
 
            template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
            const CameraInfo::UserData::MaxSizeBytes &get() const
            {
                return m_maxSizeBytes;
            }

            template<typename F>
            void forEach(const F &f) const
            {
                f(m_maxSizeBytes);
            }

            template<typename F>
            void forEach(const F &f)
            {
                f(m_maxSizeBytes);
            }

            bool operator==(const UserData &other) const;

            bool operator!=(const UserData &other) const;

            std::string toString() const;

            friend std::ostream &operator<<(std::ostream &stream, const UserData &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            void setFromString(const std::string &fullPath, const std::string &value);
 
            std::string getString(const std::string &fullPath) const;
 
            MaxSizeBytes m_maxSizeBytes;
 
            friend struct DataModel::Detail::Befriend<UserData>;
        };
 
        using Descendants = std::tuple<
            CameraInfo::FirmwareVersion,
            CameraInfo::HardwareRevision,
            CameraInfo::Model,
            CameraInfo::ModelName,
            CameraInfo::Revision,
            CameraInfo::Revision::Major,
            CameraInfo::Revision::Minor,
            CameraInfo::SerialNumber,
            CameraInfo::UserData,
            CameraInfo::UserData::MaxSizeBytes>;

        CameraInfo();

        explicit CameraInfo(const std::string &fileName);

        [[nodiscard]] static CameraInfo fromSerialized(const std::string &value);

        std::string serialize() const;

#ifndef NO_DOC
        template<
            typename... Args,
            typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0,
            typename std::enable_if<
                Zivid::Detail::TypeTraits::AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>::value,
                int>::type = 0>
#else
        template<typename... Args>
#endif
        explicit CameraInfo(Args &&...args)
        {
            using namespace Zivid::Detail::TypeTraits;
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to CameraInfo(...). "
                "Types should be listed at most once.");
 
            set(std::forward<Args>(args)...);
        }

#ifndef NO_DOC
        template<typename... Args, typename std::enable_if<sizeof...(Args) >= 2, int>::type = 0>
#else
        template<typename... Args>
#endif
        void set(Args &&...args)
        {
            using namespace Zivid::Detail::TypeTraits;
 
            using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
            static_assert(
                AllArgsAreDescendantNodes::value, "All arguments passed to set(...) must be descendant nodes.");
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to set(...). "
                "Types should be listed at most once.");
 
            Zivid::DataModel::Detail::invokeSetWithEachArgument(*this, std::forward<Args>(args)...);
        }

#ifndef NO_DOC
        template<typename... Args, typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0>
#else
        template<typename... Args>
#endif
        CameraInfo copyWith(Args &&...args) const
        {
            using namespace Zivid::Detail::TypeTraits;
 
            using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
            static_assert(
                AllArgsAreDescendantNodes::value, "All arguments passed to copyWith(...) must be descendant nodes.");
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to copyWith(...). "
                "Types should be listed at most once.");
 
            auto copy{ *this };
            copy.set(std::forward<Args>(args)...);
            return copy;
        }

        const FirmwareVersion &firmwareVersion() const
        {
            return m_firmwareVersion;
        }

        FirmwareVersion &firmwareVersion()
        {
            return m_firmwareVersion;
        }

        CameraInfo &set(const FirmwareVersion &value)
        {
            m_firmwareVersion = value;
            return *this;
        }

        const HardwareRevision &hardwareRevision() const
        {
            return m_hardwareRevision;
        }

        HardwareRevision &hardwareRevision()
        {
            return m_hardwareRevision;
        }

        CameraInfo &set(const HardwareRevision &value)
        {
            m_hardwareRevision = value;
            return *this;
        }

        const Model &model() const
        {
            return m_model;
        }

        Model &model()
        {
            return m_model;
        }

        CameraInfo &set(const Model &value)
        {
            m_model = value;
            return *this;
        }

        const ModelName &modelName() const
        {
            return m_modelName;
        }

        ModelName &modelName()
        {
            return m_modelName;
        }

        CameraInfo &set(const ModelName &value)
        {
            m_modelName = value;
            return *this;
        }

        const Revision &revision() const
        {
            return m_revision;
        }

        Revision &revision()
        {
            return m_revision;
        }

        CameraInfo &set(const Revision &value)
        {
            m_revision = value;
            return *this;
        }

        CameraInfo &set(const Revision::Major &value)
        {
            m_revision.set(value);
            return *this;
        }

        CameraInfo &set(const Revision::Minor &value)
        {
            m_revision.set(value);
            return *this;
        }

        const SerialNumber &serialNumber() const
        {
            return m_serialNumber;
        }

        SerialNumber &serialNumber()
        {
            return m_serialNumber;
        }

        CameraInfo &set(const SerialNumber &value)
        {
            m_serialNumber = value;
            return *this;
        }

        const UserData &userData() const
        {
            return m_userData;
        }

        UserData &userData()
        {
            return m_userData;
        }

        CameraInfo &set(const UserData &value)
        {
            m_userData = value;
            return *this;
        }

        CameraInfo &set(const UserData::MaxSizeBytes &value)
        {
            m_userData.set(value);
            return *this;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraInfo::FirmwareVersion>::value, int>::type = 0>
        const CameraInfo::FirmwareVersion &get() const
        {
            return m_firmwareVersion;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraInfo::HardwareRevision>::value, int>::type = 0>
        const CameraInfo::HardwareRevision &get() const
        {
            return m_hardwareRevision;
        }
 
        template<typename T, typename std::enable_if<std::is_same<T, CameraInfo::Model>::value, int>::type = 0>
        const CameraInfo::Model &get() const
        {
            return m_model;
        }
 
        template<typename T, typename std::enable_if<std::is_same<T, CameraInfo::ModelName>::value, int>::type = 0>
        const CameraInfo::ModelName &get() const
        {
            return m_modelName;
        }
 
        template<typename T, typename std::enable_if<std::is_same<T, CameraInfo::Revision>::value, int>::type = 0>
        const CameraInfo::Revision &get() const
        {
            return m_revision;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraInfo::Revision::Major>::value, int>::type = 0>
        const CameraInfo::Revision::Major &get() const
        {
            return m_revision.get<CameraInfo::Revision::Major>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraInfo::Revision::Minor>::value, int>::type = 0>
        const CameraInfo::Revision::Minor &get() const
        {
            return m_revision.get<CameraInfo::Revision::Minor>();
        }
 
        template<typename T, typename std::enable_if<std::is_same<T, CameraInfo::SerialNumber>::value, int>::type = 0>
        const CameraInfo::SerialNumber &get() const
        {
            return m_serialNumber;
        }
 
        template<typename T, typename std::enable_if<std::is_same<T, CameraInfo::UserData>::value, int>::type = 0>
        const CameraInfo::UserData &get() const
        {
            return m_userData;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraInfo::UserData::MaxSizeBytes>::value, int>::type = 0>
        const CameraInfo::UserData::MaxSizeBytes &get() const
        {
            return m_userData.get<CameraInfo::UserData::MaxSizeBytes>();
        }
 
        template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
        const CameraInfo::FirmwareVersion &get() const
        {
            return m_firmwareVersion;
        }
 
        template<size_t i, typename std::enable_if<i == 1, int>::type = 0>
        const CameraInfo::HardwareRevision &get() const
        {
            return m_hardwareRevision;
        }
 
        template<size_t i, typename std::enable_if<i == 2, int>::type = 0>
        const CameraInfo::Model &get() const
        {
            return m_model;
        }
 
        template<size_t i, typename std::enable_if<i == 3, int>::type = 0>
        const CameraInfo::ModelName &get() const
        {
            return m_modelName;
        }
 
        template<size_t i, typename std::enable_if<i == 4, int>::type = 0>
        const CameraInfo::Revision &get() const
        {
            return m_revision;
        }
 
        template<size_t i, typename std::enable_if<i == 5, int>::type = 0>
        const CameraInfo::SerialNumber &get() const
        {
            return m_serialNumber;
        }
 
        template<size_t i, typename std::enable_if<i == 6, int>::type = 0>
        const CameraInfo::UserData &get() const
        {
            return m_userData;
        }

        template<typename F>
        void forEach(const F &f) const
        {
            f(m_firmwareVersion);
            f(m_hardwareRevision);
            f(m_model);
            f(m_modelName);
            f(m_revision);
            f(m_serialNumber);
            f(m_userData);
        }

        template<typename F>
        void forEach(const F &f)
        {
            f(m_firmwareVersion);
            f(m_hardwareRevision);
            f(m_model);
            f(m_modelName);
            f(m_revision);
            f(m_serialNumber);
            f(m_userData);
        }

        bool operator==(const CameraInfo &other) const;

        bool operator!=(const CameraInfo &other) const;

        std::string toString() const;

        friend std::ostream &operator<<(std::ostream &stream, const CameraInfo &value)
        {
            return stream << value.toString();
        }

        void save(const std::string &fileName) const;

        void load(const std::string &fileName);
 
    private:
        void setFromString(const std::string &value);
 
        void setFromString(const std::string &fullPath, const std::string &value);
 
        std::string getString(const std::string &fullPath) const;
 
        FirmwareVersion m_firmwareVersion;
        HardwareRevision m_hardwareRevision;
        Model m_model;
        ModelName m_modelName;
        Revision m_revision;
        SerialNumber m_serialNumber;
        UserData m_userData;
 
        friend struct DataModel::Detail::Befriend<CameraInfo>;
    };
 
#ifndef NO_DOC
    template<>
    struct CameraInfo::Version<7>
    {
        using Type = CameraInfo;
    };
#endif
 
} // namespace Zivid
 
#ifndef NO_DOC
namespace Zivid::Detail
{
 
    ZIVID_CORE_EXPORT void save(const Zivid::CameraInfo &dataModel, std::ostream &ostream);
    ZIVID_CORE_EXPORT void load(Zivid::CameraInfo &dataModel, std::istream &istream);
 
    ZIVID_CORE_EXPORT std::vector<uint8_t> serializeToBinaryVector(const Zivid::CameraInfo &source);
    ZIVID_CORE_EXPORT void deserializeFromBinaryVector(Zivid::CameraInfo &dest, const std::vector<uint8_t> &data);
 
} // namespace Zivid::Detail
#endif
 
#ifdef _MSC_VER
#    pragma warning(pop)
#endif
 
#ifndef NO_DOC
#    if !(defined(_MSC_VER) && (_MSC_VER <= 1900))
namespace std // NOLINT
{
 
    template<>
    struct tuple_size<Zivid::CameraInfo::Revision> : integral_constant<size_t, 2>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::CameraInfo::Revision>
    {
        static_assert(i < tuple_size<Zivid::CameraInfo::Revision>::value, "Index must be less than 2");
 
        using type // NOLINT
            = decltype(declval<Zivid::CameraInfo::Revision>().get<i>());
    };
 
    template<>
    struct tuple_size<Zivid::CameraInfo::UserData> : integral_constant<size_t, 1>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::CameraInfo::UserData>
    {
        static_assert(i < tuple_size<Zivid::CameraInfo::UserData>::value, "Index must be less than 1");
 
        using type // NOLINT
            = decltype(declval<Zivid::CameraInfo::UserData>().get<i>());
    };
 
    template<>
    struct tuple_size<Zivid::CameraInfo> : integral_constant<size_t, 7>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::CameraInfo>
    {
        static_assert(i < tuple_size<Zivid::CameraInfo>::value, "Index must be less than 7");
 
        using type // NOLINT
            = decltype(declval<Zivid::CameraInfo>().get<i>());
    };
 
} // namespace std
#    endif
#endif
 
// If we have access to the DataModel library, automatically include internal DataModel
// header. This header is necessary for serialization and deserialization.
#if defined(__has_include) && !defined(NO_DOC)
#    if __has_include("Zivid/CameraInfoInternal.h") && __has_include("Zivid/DataModelNodeMetaData.h")
#        include "Zivid/CameraInfoInternal.h"
#    endif
#endif