peak_node_map.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common_c/detail/peak_common_defines.h>
 
#include <peak/backend/peak_backend.h>
#include <peak/dll_interface/peak_dll_interface_util.hpp>
#include <peak/event/peak_event.hpp>
#include <peak/generic/peak_init_once.hpp>
 
#include <type_traits>
#include <unordered_map>
#include <algorithm>
#include <cstdint>
#include <functional>
#include <iterator>
#include <memory>
#include <mutex>
#include <string>
#include <vector>
 
 
namespace peak
{
namespace core
{
namespace nodes
{
 
class BooleanNode;
class CategoryNode;
class CommandNode;
class EnumerationNode;
class EnumerationEntryNode;
class FloatNode;
class IntegerNode;
class Node;
class RegisterNode;
class StringNode;
 
} // namespace nodes
 
class Buffer;

class NodeMap
    : public InitOnce
    , public std::enable_shared_from_this<NodeMap>
{
public:
    using NodeFilterFunction = std::function<bool(const std::shared_ptr<const nodes::Node>& nodeToFilter)>;
 

    class ScopedNodeMapLock
    {
    public:
        ScopedNodeMapLock() = delete;
        ~ScopedNodeMapLock();
        ScopedNodeMapLock(const ScopedNodeMapLock& other) = delete;
        ScopedNodeMapLock& operator=(const ScopedNodeMapLock& other) = delete;
        ScopedNodeMapLock(ScopedNodeMapLock&& other) = delete;
        ScopedNodeMapLock& operator=(ScopedNodeMapLock&& other) = delete;
 
    private:
        friend NodeMap;
        friend ClassCreator<ScopedNodeMapLock>;
        explicit ScopedNodeMapLock(const std::shared_ptr<NodeMap>& nodeMap);
        explicit ScopedNodeMapLock(const std::shared_ptr<NodeMap>& nodeMap, std::adopt_lock_t t);
        std::shared_ptr<NodeMap> m_nodeMap;
    };
 
    NodeMap() = delete;
    ~NodeMap() = default;
    NodeMap(const NodeMap& other) = delete;
    NodeMap& operator=(const NodeMap& other) = delete;
    NodeMap(NodeMap&& other) = delete;
    NodeMap& operator=(NodeMap&& other) = delete;

    PEAK_COMMON_NO_DISCARD bool HasNode(const std::string& name) const;

    template <class NodeType, typename std::enable_if<std::is_base_of<nodes::Node, NodeType>::value, int>::type = 0>
    PEAK_COMMON_NO_DISCARD bool HasNode(const std::string& name)
    {
        InitializeIfNecessary();
        PEAK_NODE_HANDLE nodeHandle{ nullptr };
        if (PEAK_C_ABI_PREFIX PEAK_NodeMap_FindNode(m_backendHandle, name.c_str(), name.size() + 1, &nodeHandle)
            != PEAK_RETURN_CODE_SUCCESS)
        {
            return false;
        }
 
        return std::dynamic_pointer_cast<NodeType>(m_nodesByName.at(name)) != nullptr;
    }

    PEAK_COMMON_NO_DISCARD std::shared_ptr<nodes::Node> FindNode(const std::string& name);

    template <class NodeType, typename std::enable_if<std::is_base_of<nodes::Node, NodeType>::value, int>::type = 0>
    PEAK_COMMON_NO_DISCARD std::shared_ptr<NodeType> FindNode(const std::string& name)
    {
        auto castedNode = std::dynamic_pointer_cast<NodeType>(FindNode(name));
        if (!castedNode)
        {
            throw InvalidCastException("Invalid node cast!");
        }
 
        return castedNode;
    }

    PEAK_COMMON_NO_DISCARD std::shared_ptr<nodes::Node> TryFindNode(const std::string& name);

    template <class NodeType, typename std::enable_if<std::is_base_of<nodes::Node, NodeType>::value, int>::type = 0>
    PEAK_COMMON_NO_DISCARD std::shared_ptr<NodeType> TryFindNode(const std::string& name)
    {
        auto node = TryFindNode(name);
        if (node == nullptr)
        {
            return nullptr;
        }
 
        auto castedNode = std::dynamic_pointer_cast<NodeType>(node);
        if (!castedNode)
        {
            throw InvalidCastException("Invalid node cast!");
        }
 
        return castedNode;
    }

    void InvalidateNodes();

    void PollNodes(int64_t elapsedTime_ms);

    PEAK_COMMON_NO_DISCARD std::vector<std::shared_ptr<nodes::Node>> Nodes() const;

    PEAK_COMMON_NO_DISCARD bool HasBufferSupportedChunks(const std::shared_ptr<Buffer>& buffer) const;

    void UpdateChunkNodes(const std::shared_ptr<Buffer>& buffer);

    PEAK_COMMON_NO_DISCARD bool HasEventSupportedData(const std::unique_ptr<Event>& event) const;

    void UpdateEventNodes(const std::unique_ptr<Event>& event);

    void StoreToFile(const std::string& filePath) const;

    void LoadFromFile(const std::string& filePath);

    PEAK_COMMON_NO_DISCARD std::unique_ptr<ScopedNodeMapLock> Lock();

    PEAK_COMMON_NO_DISCARD std::unique_ptr<ScopedNodeMapLock> TryLock();

    PEAK_COMMON_NO_DISCARD PEAK_NODE_MAP_HANDLE Handle() const
    {
        return m_backendHandle;
    }
 
private:
    std::shared_ptr<nodes::Node> NodeFromHandle(PEAK_NODE_HANDLE nodeHandle) const;
 
    friend ClassCreator<NodeMap>;
    explicit NodeMap(PEAK_NODE_MAP_HANDLE nodeMapHandle);
    PEAK_NODE_MAP_HANDLE m_backendHandle;
 
    void Initialize() const override;
    mutable std::vector<std::shared_ptr<nodes::Node>> m_nodes;
    mutable std::unordered_map<std::string, std::shared_ptr<nodes::Node>> m_nodesByName;
};
 
} /* namespace core */
} /* namespace peak */
 
#include <peak/node_map/peak_boolean_node.hpp>
#include <peak/node_map/peak_category_node.hpp>
#include <peak/node_map/peak_command_node.hpp>
#include <peak/node_map/peak_enumeration_entry_node.hpp>
#include <peak/node_map/peak_enumeration_node.hpp>
#include <peak/node_map/peak_float_node.hpp>
#include <peak/node_map/peak_integer_node.hpp>
#include <peak/node_map/peak_node.hpp>
#include <peak/node_map/peak_register_node.hpp>
#include <peak/node_map/peak_string_node.hpp>
 
 
/* Implementation */
namespace peak
{
namespace core
{
 
inline NodeMap::NodeMap(PEAK_NODE_MAP_HANDLE nodeMapHandle)
    : m_backendHandle(nodeMapHandle)
    , m_nodes()
    , m_nodesByName()
{}
 
inline bool NodeMap::HasNode(const std::string& name) const
{
    return QueryNumericFromCInterfaceFunction<PEAK_BOOL8>([&](PEAK_BOOL8* hasNode) {
        return PEAK_C_ABI_PREFIX PEAK_NodeMap_GetHasNode(m_backendHandle, name.c_str(), name.size() + 1, hasNode);
    }) > 0;
}
 
inline std::shared_ptr<nodes::Node> NodeMap::FindNode(const std::string& name)
{
    InitializeIfNecessary();
 
    (void)QueryNumericFromCInterfaceFunction<PEAK_NODE_HANDLE>([&](PEAK_NODE_HANDLE* nodeHandle) {
        return PEAK_C_ABI_PREFIX PEAK_NodeMap_FindNode(
            m_backendHandle, name.c_str(), name.size() + 1, nodeHandle);
    });
 
    return m_nodesByName.at(name);
}
 
inline std::shared_ptr<nodes::Node> NodeMap::TryFindNode(const std::string& name)
{
    InitializeIfNecessary();
 
    const auto cNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_NODE_HANDLE>(
        [&](PEAK_NODE_HANDLE* nodeHandle) {
            return PEAK_C_ABI_PREFIX PEAK_NodeMap_TryFindNode(
                m_backendHandle, name.c_str(), name.size() + 1, nodeHandle);
        });
 
    if (cNodeHandle == nullptr)
    {
        return nullptr;
    }
 
    return m_nodesByName.at(name);
}
 
inline void NodeMap::InvalidateNodes()
{
    CallAndCheckCInterfaceFunction(
        [&] { return PEAK_C_ABI_PREFIX PEAK_NodeMap_InvalidateNodes(m_backendHandle); });
}
 
inline void NodeMap::PollNodes(int64_t elapsedTime_ms)
{
    CallAndCheckCInterfaceFunction(
        [&] { return PEAK_C_ABI_PREFIX PEAK_NodeMap_PollNodes(m_backendHandle, elapsedTime_ms); });
}
 
inline std::vector<std::shared_ptr<nodes::Node>> NodeMap::Nodes() const
{
    InitializeIfNecessary();
 
    return m_nodes;
}
 
inline bool NodeMap::HasEventSupportedData(const std::unique_ptr<Event>& event) const
{
    if (event == nullptr)
    {
        throw InvalidArgumentException("The given event is a nullptr!");
    }
 
    return QueryNumericFromCInterfaceFunction<PEAK_BOOL8>([&](PEAK_BOOL8* hasSupportedData) {
        return PEAK_C_ABI_PREFIX PEAK_NodeMap_GetHasEventSupportedData(
            m_backendHandle, event->m_backendHandle, hasSupportedData);
    }) > 0;
}
 
inline void NodeMap::UpdateEventNodes(const std::unique_ptr<Event>& event)
{
    if (event == nullptr)
    {
        throw InvalidArgumentException("The given event is a nullptr!");
    }
 
    CallAndCheckCInterfaceFunction(
        [&] { return PEAK_C_ABI_PREFIX PEAK_NodeMap_UpdateEventNodes(m_backendHandle, event->m_backendHandle); });
}
 
inline void NodeMap::StoreToFile(const std::string& filePath) const
{
    CallAndCheckCInterfaceFunction([&] {
        return PEAK_C_ABI_PREFIX PEAK_NodeMap_StoreToFile(m_backendHandle, filePath.c_str(), filePath.size() + 1);
    });
}
 
inline void NodeMap::LoadFromFile(const std::string& filePath)
{
    InitializeIfNecessary();
 
    CallAndCheckCInterfaceFunction([&] {
        return PEAK_C_ABI_PREFIX PEAK_NodeMap_LoadFromFile(
            m_backendHandle, filePath.c_str(), filePath.size() + 1);
    });
}
 
inline NodeMap::ScopedNodeMapLock::ScopedNodeMapLock(const std::shared_ptr<NodeMap>& nodeMap)
    : m_nodeMap(nodeMap)
{
    CallAndCheckCInterfaceFunction(
        [&] { return PEAK_C_ABI_PREFIX PEAK_NodeMap_Lock(m_nodeMap->m_backendHandle); });
}
 
inline NodeMap::ScopedNodeMapLock::ScopedNodeMapLock(const std::shared_ptr<NodeMap>& nodeMap, std::adopt_lock_t)
    : m_nodeMap(nodeMap)
{}
 
inline NodeMap::ScopedNodeMapLock::~ScopedNodeMapLock()
{
    CallAndCheckCInterfaceFunction(
        [&] { return PEAK_C_ABI_PREFIX PEAK_NodeMap_Unlock(m_nodeMap->m_backendHandle); });
}
 
inline std::unique_ptr<NodeMap::ScopedNodeMapLock> NodeMap::Lock()
{
    return std::make_unique<ClassCreator<ScopedNodeMapLock>>(shared_from_this());
}
 
inline std::unique_ptr<NodeMap::ScopedNodeMapLock> NodeMap::TryLock()
{
    PEAK_BOOL8 locked{ false };
    CallAndCheckCInterfaceFunction(
        [&] { return PEAK_C_ABI_PREFIX PEAK_NodeMap_TryLock(m_backendHandle, &locked); });
 
    if (!locked)
    {
        return {};
    }
 
    return std::make_unique<ClassCreator<ScopedNodeMapLock>>(shared_from_this(), std::adopt_lock);
}
 
inline std::shared_ptr<nodes::Node> NodeMap::NodeFromHandle(PEAK_NODE_HANDLE nodeHandle) const
{
    auto nodeType = QueryNumericFromCInterfaceFunction<PEAK_NODE_TYPE>(
        [&](PEAK_NODE_TYPE* _nodeType) { return PEAK_C_ABI_PREFIX PEAK_Node_GetType(nodeHandle, _nodeType); });
 
    switch (nodeType)
    {
    case PEAK_NODE_TYPE_INTEGER: {
        auto integerNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_INTEGER_NODE_HANDLE>(
            [&](PEAK_INTEGER_NODE_HANDLE* _integerNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToIntegerNode(nodeHandle, _integerNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::IntegerNode>>(
            integerNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    case PEAK_NODE_TYPE_BOOLEAN: {
        auto booleanNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_BOOLEAN_NODE_HANDLE>(
            [&](PEAK_BOOLEAN_NODE_HANDLE* _booleanNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToBooleanNode(nodeHandle, _booleanNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::BooleanNode>>(
            booleanNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    case PEAK_NODE_TYPE_COMMAND: {
        auto commandNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_COMMAND_NODE_HANDLE>(
            [&](PEAK_COMMAND_NODE_HANDLE* _commandNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToCommandNode(nodeHandle, _commandNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::CommandNode>>(
            commandNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    case PEAK_NODE_TYPE_FLOAT: {
        auto floatNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_FLOAT_NODE_HANDLE>(
            [&](PEAK_FLOAT_NODE_HANDLE* _floatNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToFloatNode(nodeHandle, _floatNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::FloatNode>>(
            floatNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    case PEAK_NODE_TYPE_STRING: {
        auto stringNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_STRING_NODE_HANDLE>(
            [&](PEAK_STRING_NODE_HANDLE* _stringNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToStringNode(nodeHandle, _stringNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::StringNode>>(
            stringNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    case PEAK_NODE_TYPE_REGISTER: {
        auto registerNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_REGISTER_NODE_HANDLE>(
            [&](PEAK_REGISTER_NODE_HANDLE* _registerNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToRegisterNode(nodeHandle, _registerNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::RegisterNode>>(
            registerNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    case PEAK_NODE_TYPE_CATEGORY: {
        auto categoryNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_CATEGORY_NODE_HANDLE>(
            [&](PEAK_CATEGORY_NODE_HANDLE* _categoryNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToCategoryNode(nodeHandle, _categoryNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::CategoryNode>>(
            categoryNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    case PEAK_NODE_TYPE_ENUMERATION: {
        auto enumerationNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_ENUMERATION_NODE_HANDLE>(
            [&](PEAK_ENUMERATION_NODE_HANDLE* _enumerationNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToEnumerationNode(nodeHandle, _enumerationNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::EnumerationNode>>(
            enumerationNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    case PEAK_NODE_TYPE_ENUMERATION_ENTRY: {
        auto enumerationEntryNodeHandle = QueryNumericFromCInterfaceFunction<PEAK_ENUMERATION_ENTRY_NODE_HANDLE>(
            [&](PEAK_ENUMERATION_ENTRY_NODE_HANDLE* _enumerationEntryNodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_Node_ToEnumerationEntryNode(
                    nodeHandle, _enumerationEntryNodeHandle);
            });
 
        return std::make_shared<ClassCreator<nodes::EnumerationEntryNode>>(
            enumerationEntryNodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    default: {
        return std::make_shared<ClassCreator<nodes::Node>>(
            nodeHandle, std::const_pointer_cast<core::NodeMap>(shared_from_this()));
    }
    }
}
 
inline void NodeMap::Initialize() const
{
    auto numNodes = QueryNumericFromCInterfaceFunction<size_t>([&](size_t* _numNodes) {
        return PEAK_C_ABI_PREFIX PEAK_NodeMap_GetNumNodes(m_backendHandle, _numNodes);
    });
 
    for (size_t x = 0; x < numNodes; ++x)
    {
        auto nodeHandle = QueryNumericFromCInterfaceFunction<PEAK_NODE_HANDLE>(
            [&](PEAK_NODE_HANDLE* _nodeHandle) {
                return PEAK_C_ABI_PREFIX PEAK_NodeMap_GetNode(m_backendHandle, x, _nodeHandle);
            });
 
        auto node = NodeFromHandle(nodeHandle);
 
        m_nodes.emplace_back(node);
        m_nodesByName.emplace(node->Name(), node);
    }
}
 
} /* namespace core */
} /* namespace peak */