IDS peak genericC++ v1.16.0
Loading...
Searching...
No Matches
peak_boolean_node.hpp
Go to the documentation of this file.
1
10
11#pragma once
12
13
15#include <peak/dll_interface/peak_dll_interface_util.hpp>
18#include <type_traits>
19
20
21namespace peak
22{
23namespace core
24{
25namespace nodes
26{
27
33class BooleanNode : public Node
34{
35public:
36 static constexpr auto NodeType = nodes::NodeType::Boolean;
37 using NodeDataType = bool;
38 using NodeHasRange = std::false_type;
39
40 BooleanNode() = delete;
41 ~BooleanNode() override = default;
42 BooleanNode(const BooleanNode& other) = delete;
43 BooleanNode& operator=(const BooleanNode& other) = delete;
44 BooleanNode(BooleanNode&& other) = delete;
45 BooleanNode& operator=(BooleanNode&& other) = delete;
46
60 bool Value(NodeCacheUsePolicy cacheUsePolicy = NodeCacheUsePolicy::UseCache) const;
61
72 void SetValue(bool value);
73
74private:
75 friend ClassCreator<BooleanNode>;
76 BooleanNode(PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, const std::weak_ptr<NodeMap>& parentNodeMap);
77 PEAK_BOOLEAN_NODE_HANDLE m_backendHandle;
78};
79
80} /* namespace nodes */
81} /* namespace core */
82} /* namespace peak */
83
84/* Implementation */
85namespace peak
86{
87namespace core
88{
89namespace nodes
90{
91
93 PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, const std::weak_ptr<NodeMap>& parentNodeMap)
94 : Node(QueryNumericFromCInterfaceFunction<PEAK_NODE_HANDLE>([&](PEAK_NODE_HANDLE* nodeHandle) {
95 return PEAK_C_ABI_PREFIX PEAK_BooleanNode_ToNode(booleanNodeHandle, nodeHandle);
96 }),
97 parentNodeMap)
98 , m_backendHandle(booleanNodeHandle)
99{}
100
101inline bool BooleanNode::Value(NodeCacheUsePolicy cacheUsePolicy /* = NodeCacheUsePolicy::UseCache */) const
102{
103 return QueryNumericFromCInterfaceFunction<PEAK_BOOL8>([&](PEAK_BOOL8* value) {
105 m_backendHandle, static_cast<PEAK_NODE_CACHE_USE_POLICY>(cacheUsePolicy), value);
106 }) > 0;
107}
108
109inline void BooleanNode::SetValue(bool value)
110{
111 CallAndCheckCInterfaceFunction(
112 [&] { return PEAK_C_ABI_PREFIX PEAK_BooleanNode_SetValue(m_backendHandle, value); });
113}
114
115} /* namespace nodes */
116} /* namespace core */
117} /* namespace peak */
BooleanNode(const BooleanNode &other)=delete
bool Value(NodeCacheUsePolicy cacheUsePolicy=NodeCacheUsePolicy::UseCache) const
Returns the value.
Definition peak_boolean_node.hpp:101
BooleanNode & operator=(BooleanNode &&other)=delete
bool NodeDataType
Definition peak_boolean_node.hpp:37
BooleanNode(BooleanNode &&other)=delete
void SetValue(bool value)
Sets the given value.
Definition peak_boolean_node.hpp:109
static constexpr auto NodeType
Definition peak_boolean_node.hpp:36
BooleanNode & operator=(const BooleanNode &other)=delete
std::false_type NodeHasRange
Definition peak_boolean_node.hpp:38
~BooleanNode() override=default
NodeCacheUsePolicy
Defines how node value access should interact with the internal cache.
Definition peak_common_node_enums.hpp:37
@ Boolean
Definition peak_node.hpp:93
@ UseCache
Definition peak_common_node_enums.hpp:39
The "nodes" namespace contains all GenAPI node types.
Definition peak_boolean_node.hpp:26
The "core" namespace contains the direct GenAPI and GenTL wrapper.
Definition peak_buffer.hpp:34
The "peak" namespace directly contains convenience functionality like the DeviceManager as well as th...
Definition peak_dynamic_loader.h:35
PEAK_C_API PEAK_BooleanNode_ToNode(PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given boolean node to a node.
PEAK_C_API PEAK_BooleanNode_SetValue(PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_BOOL8 value)
Tells the given boolean node to set the given value.
PEAK_C_API PEAK_BooleanNode_GetValue(PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, PEAK_BOOL8 *value)
Asks the given boolean node for its value.
struct PEAK_NODE * PEAK_NODE_HANDLE
Definition peak_backend.h:429
int32_t PEAK_NODE_CACHE_USE_POLICY
Definition peak_backend.h:242
int8_t PEAK_BOOL8
Definition peak_backend.h:43
struct PEAK_BOOLEAN_NODE * PEAK_BOOLEAN_NODE_HANDLE
Definition peak_backend.h:437
#define PEAK_C_ABI_PREFIX
Definition peak_dll_defines.h:16