Detail.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2024 (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 <stdexcept>
#include <type_traits>
#include <utility>
 
namespace Zivid
{
    namespace DataModel
    {
#ifndef NO_DOC
        namespace Detail
        {
            template<typename DataModel>
            void invokeSetWithEachArgument(DataModel & /*dm*/)
            {
                // Base case, do nothing
            }
 
            template<typename DataModel, typename Arg, typename... Args>
            void invokeSetWithEachArgument(DataModel &dm, Arg &&arg, Args &&...args)
            {
                dm.set(std::forward<Arg>(arg));
                invokeSetWithEachArgument(dm, std::forward<Args>(args)...);
            }
 
            // Note: This Optional class will default construct an object of the contained type when the
            // optional is unset.
            // This class should not be accessible directly via the public API.
            template<typename T>
            class Optional
            {
                static_assert(std::is_default_constructible<T>::value, "T needs to be default_constructible");
 
            public:
                constexpr Optional()
                    : m_hasValue{ false }
                    , m_value{}
                {}
 
                explicit constexpr Optional(const T &value)
                    : m_hasValue{ true }
                    , m_value{ value }
                {}
 
                explicit constexpr Optional(T &&value)
                    : m_hasValue{ true }
                    , m_value{ std::move(value) }
                {}
 
                const T &value() const
                {
                    if(!hasValue())
                    {
                        throw std::runtime_error("value() called on unset optional");
                    }
                    return m_value;
                }
 
                bool hasValue() const
                {
                    return m_hasValue;
                }
 
                void reset()
                {
                    m_hasValue = false;
                    m_value = T{};
                }
 
                bool operator==(const Optional<T> &other) const
                {
                    if(hasValue() != other.hasValue())
                    {
                        return false;
                    }
                    if(!hasValue())
                    {
                        return true;
                    }
                    return value() == other.value();
                }
 
                bool operator!=(const Optional<T> &other) const
                {
                    return !operator==(other);
                }
 
                bool operator<(const Optional<T> &other) const
                {
                    if(!hasValue() && !other.hasValue())
                    {
                        return false;
                    }
                    if(hasValue() && !other.hasValue())
                    {
                        return false;
                    }
                    if(!hasValue() && other.hasValue())
                    {
                        return true;
                    }
                    return m_value < other.m_value;
                }
 
                bool operator>(const Optional<T> &other) const
                {
                    if(!hasValue() && !other.hasValue())
                    {
                        return false;
                    }
                    if(hasValue() && !other.hasValue())
                    {
                        return true;
                    }
                    if(!hasValue() && other.hasValue())
                    {
                        return false;
                    }
                    return m_value > other.m_value;
                }
 
                bool operator<=(const Optional<T> &other) const
                {
                    return (operator==(other) || operator<(other));
                }
 
                bool operator>=(const Optional<T> &other) const
                {
                    return (operator==(other) || operator>(other));
                }
 
            private:
                bool m_hasValue;
                T m_value;
            };
 
            template<typename T>
            struct Befriend
            {
                static void setFromString(T &target, const std::string &value)
                {
                    target.setFromString(value);
                }
 
                static void setFromString(T &target, const std::string &path, const std::string &value)
                {
                    target.setFromString(path, value);
                }
 
                static std::string getString(const T &target, const std::string &path)
                {
                    return target.getString(path);
                }
            };
 
            template<typename T>
            void setFromString(T &target, const std::string &value)
            {
                Befriend<T>::setFromString(target, value);
            }
 
            template<typename T>
            void setFromString(T &target, const std::string &path, const std::string &value)
            {
                Befriend<T>::setFromString(target, path, value);
            }
 
            template<typename T>
            std::string getString(const T &target, const std::string &path)
            {
                return Befriend<T>::getString(target, path);
            }
        } // namespace Detail
#endif
    } // namespace DataModel
} // namespace Zivid