peak_command_node.hpp

Go to the documentation of this file.

 
#pragma once
 
 
#include <type_traits>
#include <peak/backend/peak_backend.h>
#include <peak/common/peak_timeout.hpp>
#include <peak/dll_interface/peak_dll_interface_util.hpp>
#include <peak/node_map/peak_common_node_enums.hpp>
#include <peak/node_map/peak_node.hpp>
 
 
namespace peak
{
namespace core
{
namespace nodes
{

class CommandNode : public Node
{
public:
    static constexpr auto NodeType = nodes::NodeType::Command;
    using NodeDataType = void;
    using NodeHasRange = std::false_type;
 
    CommandNode() = delete;
    ~CommandNode() override = default;
    CommandNode(const CommandNode& other) = delete;
    CommandNode& operator=(const CommandNode& other) = delete;
    CommandNode(CommandNode&& other) = delete;
    CommandNode& operator=(CommandNode&& other) = delete;

    PEAK_COMMON_NO_DISCARD bool IsDone() const;

    void Execute();

    void WaitUntilDone(Timeout waitTimeout_ms = 500);

    void ExecuteAndWait(Timeout waitTimeout_ms = 500);
 
 
private:
    friend ClassCreator<CommandNode>;
    CommandNode(PEAK_COMMAND_NODE_HANDLE commandNodeHandle, const std::weak_ptr<NodeMap>& parentNodeMap);
    PEAK_COMMAND_NODE_HANDLE m_backendHandle;
};
 
} /* namespace nodes */
} /* namespace core */
} /* namespace peak */
 
/* Implementation */
namespace peak
{
namespace core
{
namespace nodes
{
 
inline CommandNode::CommandNode(
    PEAK_COMMAND_NODE_HANDLE commandNodeHandle, const std::weak_ptr<NodeMap>& parentNodeMap)
    : Node(QueryNumericFromCInterfaceFunction<PEAK_NODE_HANDLE>([&](PEAK_NODE_HANDLE* nodeHandle) {
        return PEAK_C_ABI_PREFIX PEAK_CommandNode_ToNode(commandNodeHandle, nodeHandle);
    }),
          parentNodeMap)
    , m_backendHandle(commandNodeHandle)
{}
 
inline bool CommandNode::IsDone() const
{
    return QueryNumericFromCInterfaceFunction<PEAK_BOOL8>([&](PEAK_BOOL8* isDone) {
        return PEAK_C_ABI_PREFIX PEAK_CommandNode_GetIsDone(m_backendHandle, isDone);
    }) > 0;
}
inline void CommandNode::Execute()
{
    CallAndCheckCInterfaceFunction([&] { return PEAK_C_ABI_PREFIX PEAK_CommandNode_Execute(m_backendHandle); });
}
 
inline void CommandNode::WaitUntilDone(Timeout waitTimeout_ms /*= 500*/)
{
    CallAndCheckCInterfaceFunction(
        [&] { return PEAK_C_ABI_PREFIX PEAK_CommandNode_WaitUntilDone(m_backendHandle, waitTimeout_ms); });
}
 
inline void CommandNode::ExecuteAndWait(Timeout waitTimeout_ms)
{
    Execute();
    WaitUntilDone(waitTimeout_ms);
}
 
} /* namespace nodes */
} /* namespace core */
} /* namespace peak */