FrameInfo.h

Go to the documentation of this file.

 
/*******************************************************************************
 * This file is part of the Zivid 3D Camera API
 *
 * Copyright 2015-2022 (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
{
    class ZIVID_CORE_EXPORT FrameInfo
    {
    public:
        static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;
 
        static constexpr const char *path{ "" };
 
        static constexpr const char *name{ "FrameInfo" };
 
        static constexpr const char *description{ R"description(Various information for a frame)description" };
 
        static constexpr size_t version{ 2 };
 
#ifndef NO_DOC
        template<size_t>
        struct Version;
 
        using LatestVersion = Zivid::FrameInfo;
 
        // 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{ 'f', 'i', 'f' };
 
#endif
 
        class ZIVID_CORE_EXPORT SoftwareVersion
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;
 
            static constexpr const char *path{ "SoftwareVersion" };
 
            static constexpr const char *name{ "SoftwareVersion" };
 
            static constexpr const char *description{
                R"description(The version information for installed software at the time of image capture)description"
            };
 
            class ZIVID_CORE_EXPORT Core
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "SoftwareVersion/Core" };
 
                static constexpr const char *name{ "Core" };
 
                static constexpr const char *description{ R"description(Core version)description" };
 
                using ValueType = std::string;
 
                static constexpr Range<ValueType::size_type> validSize()
                {
                    return { 0, std::numeric_limits<ValueType::size_type>::max() };
                }
 
                Core() = default;
 
                explicit Core(std::string value)
                    : m_value{ std::move(value) }
                {}
 
                const std::string &value() const;
 
                std::string toString() const;
 
                bool operator==(const Core &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const Core &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const Core &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const Core &other) const
                {
                    return m_value > other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const Core &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                std::string m_value{ "No-version" };
 
                friend struct DataModel::Detail::Befriend<Core>;
            };
 
            using Descendants = std::tuple<FrameInfo::SoftwareVersion::Core>;
 
            SoftwareVersion();
 
#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 SoftwareVersion(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                static_assert(AllArgsDecayedAreUnique<Args...>::value,
                              "Found duplicate types among the arguments passed to SoftwareVersion(...). "
                              "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
            SoftwareVersion 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 Core &core() const
            {
                return m_core;
            }
 
            Core &core()
            {
                return m_core;
            }
 
            SoftwareVersion &set(const Core &value)
            {
                m_core = value;
                return *this;
            }
 
            template<typename T,
                     typename std::enable_if<std::is_same<T, FrameInfo::SoftwareVersion::Core>::value, int>::type = 0>
            const FrameInfo::SoftwareVersion::Core &get() const
            {
                return m_core;
            }
 
            template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
            const FrameInfo::SoftwareVersion::Core &get() const
            {
                return m_core;
            }
 
            template<typename F>
            void forEach(const F &f) const
            {
                f(m_core);
            }
 
            template<typename F>
            void forEach(const F &f)
            {
                f(m_core);
            }
 
            bool operator==(const SoftwareVersion &other) const;
 
            bool operator!=(const SoftwareVersion &other) const;
 
            std::string toString() const;
 
            friend std::ostream &operator<<(std::ostream &stream, const SoftwareVersion &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;
 
            Core m_core;
 
            friend struct DataModel::Detail::Befriend<SoftwareVersion>;
        };
 
        class ZIVID_CORE_EXPORT TimeStamp
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
            static constexpr const char *path{ "TimeStamp" };
 
            static constexpr const char *name{ "TimeStamp" };
 
            static constexpr const char *description{ R"description(The time of frame capture)description" };
 
            using ValueType = std::chrono::system_clock::time_point;
 
            static constexpr Range<std::chrono::system_clock::time_point> validRange()
            {
                return { std::chrono::system_clock::time_point::min(), std::chrono::system_clock::time_point::max() };
            }
 
            TimeStamp() = default;
 
            explicit constexpr TimeStamp(std::chrono::system_clock::time_point value)
                : m_value{ value }
            {}
 
            std::chrono::system_clock::time_point value() const;
 
            std::string toString() const;
 
            bool operator==(const TimeStamp &other) const
            {
                return m_value == other.m_value;
            }
 
            bool operator!=(const TimeStamp &other) const
            {
                return m_value != other.m_value;
            }
 
            bool operator<(const TimeStamp &other) const
            {
                return m_value < other.m_value;
            }
 
            bool operator>(const TimeStamp &other) const
            {
                return m_value > other.m_value;
            }
 
            friend std::ostream &operator<<(std::ostream &stream, const TimeStamp &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            std::chrono::system_clock::time_point m_value{};
 
            friend struct DataModel::Detail::Befriend<TimeStamp>;
        };
 
        using Descendants =
            std::tuple<FrameInfo::SoftwareVersion, FrameInfo::SoftwareVersion::Core, FrameInfo::TimeStamp>;
 
        FrameInfo();
 
        explicit FrameInfo(const std::string &fileName);
 
#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 FrameInfo(Args &&...args)
        {
            using namespace Zivid::Detail::TypeTraits;
 
            static_assert(AllArgsDecayedAreUnique<Args...>::value,
                          "Found duplicate types among the arguments passed to FrameInfo(...). "
                          "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
        FrameInfo 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 SoftwareVersion &softwareVersion() const
        {
            return m_softwareVersion;
        }
 
        SoftwareVersion &softwareVersion()
        {
            return m_softwareVersion;
        }
 
        FrameInfo &set(const SoftwareVersion &value)
        {
            m_softwareVersion = value;
            return *this;
        }
 
        FrameInfo &set(const SoftwareVersion::Core &value)
        {
            m_softwareVersion.set(value);
            return *this;
        }
 
        const TimeStamp &timeStamp() const
        {
            return m_timeStamp;
        }
 
        TimeStamp &timeStamp()
        {
            return m_timeStamp;
        }
 
        FrameInfo &set(const TimeStamp &value)
        {
            m_timeStamp = value;
            return *this;
        }
 
        template<typename T, typename std::enable_if<std::is_same<T, FrameInfo::SoftwareVersion>::value, int>::type = 0>
        const FrameInfo::SoftwareVersion &get() const
        {
            return m_softwareVersion;
        }
 
        template<typename T,
                 typename std::enable_if<std::is_same<T, FrameInfo::SoftwareVersion::Core>::value, int>::type = 0>
        const FrameInfo::SoftwareVersion::Core &get() const
        {
            return m_softwareVersion.get<FrameInfo::SoftwareVersion::Core>();
        }
 
        template<typename T, typename std::enable_if<std::is_same<T, FrameInfo::TimeStamp>::value, int>::type = 0>
        const FrameInfo::TimeStamp &get() const
        {
            return m_timeStamp;
        }
 
        template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
        const FrameInfo::SoftwareVersion &get() const
        {
            return m_softwareVersion;
        }
 
        template<size_t i, typename std::enable_if<i == 1, int>::type = 0>
        const FrameInfo::TimeStamp &get() const
        {
            return m_timeStamp;
        }
 
        template<typename F>
        void forEach(const F &f) const
        {
            f(m_softwareVersion);
            f(m_timeStamp);
        }
 
        template<typename F>
        void forEach(const F &f)
        {
            f(m_softwareVersion);
            f(m_timeStamp);
        }
 
        bool operator==(const FrameInfo &other) const;
 
        bool operator!=(const FrameInfo &other) const;
 
        std::string toString() const;
 
        friend std::ostream &operator<<(std::ostream &stream, const FrameInfo &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;
 
        SoftwareVersion m_softwareVersion;
        TimeStamp m_timeStamp;
 
        friend struct DataModel::Detail::Befriend<FrameInfo>;
    };
 
#ifndef NO_DOC
    template<>
    struct FrameInfo::Version<2>
    {
        using Type = FrameInfo;
    };
#endif
 
} // namespace Zivid
 
#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::FrameInfo::SoftwareVersion> : integral_constant<size_t, 1>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::FrameInfo::SoftwareVersion>
    {
        static_assert(i < tuple_size<Zivid::FrameInfo::SoftwareVersion>::value, "Index must be less than 1");
 
        using type // NOLINT
            = decltype(declval<Zivid::FrameInfo::SoftwareVersion>().get<i>());
    };
 
    template<>
    struct tuple_size<Zivid::FrameInfo> : integral_constant<size_t, 2>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::FrameInfo>
    {
        static_assert(i < tuple_size<Zivid::FrameInfo>::value, "Index must be less than 2");
 
        using type // NOLINT
            = decltype(declval<Zivid::FrameInfo>().get<i>());
    };
 
} // namespace std
#    endif
#endif