IDS peak genericC++ v1.7.3
Loading...
Searching...
No Matches
peak_register_node.hpp
Go to the documentation of this file.
1
11#pragma once
12
13
15#include <peak/dll_interface/peak_dll_interface_util.hpp>
16#include <peak/error_handling/peak_error_handling.hpp>
19
20#include <cstddef>
21#include <cstdint>
22#include <vector>
23
24
25namespace peak
26{
27namespace core
28{
29namespace nodes
30{
31
36class RegisterNode : public Node
37{
38public:
39 RegisterNode() = delete;
40 ~RegisterNode() override = default;
41 RegisterNode(const RegisterNode& other) = delete;
42 RegisterNode& operator=(const RegisterNode& other) = delete;
43 RegisterNode(RegisterNode&& other) = delete;
45
55 uint64_t Address() const;
56
66 size_t Length() const;
67
81 std::vector<uint8_t> Read(size_t numBytes, NodeCacheUsePolicy cacheUsePolicy = NodeCacheUsePolicy::UseCache) const;
82
93 void Write(const std::vector<uint8_t>& bytes);
94
95private:
96 friend ClassCreator<RegisterNode>;
97 RegisterNode(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, const std::weak_ptr<NodeMap>& parentNodeMap);
98 PEAK_REGISTER_NODE_HANDLE m_backendHandle;
99};
100
101} /* namespace nodes */
102} /* namespace core */
103} /* namespace peak */
104
105/* Implementation */
106namespace peak
107{
108namespace core
109{
110namespace nodes
111{
112
114 PEAK_REGISTER_NODE_HANDLE registerNodeHandle, const std::weak_ptr<NodeMap>& parentNodeMap)
115 : Node(QueryNumericFromCInterfaceFunction<PEAK_NODE_HANDLE>([&](PEAK_NODE_HANDLE* nodeHandle) {
116 return PEAK_C_ABI_PREFIX PEAK_RegisterNode_ToNode(registerNodeHandle, nodeHandle);
117 }),
118 parentNodeMap)
119 , m_backendHandle(registerNodeHandle)
120{}
121
122inline uint64_t RegisterNode::Address() const
123{
124 return QueryNumericFromCInterfaceFunction<uint64_t>([&](uint64_t* address) {
125 return PEAK_C_ABI_PREFIX PEAK_RegisterNode_GetAddress(m_backendHandle, address);
126 });
127}
128
129inline size_t RegisterNode::Length() const
130{
131 return QueryNumericFromCInterfaceFunction<size_t>(
132 [&](size_t* length) { return PEAK_C_ABI_PREFIX PEAK_RegisterNode_GetLength(m_backendHandle, length); });
133}
134
135inline std::vector<uint8_t> RegisterNode::Read(
136 size_t numBytes, NodeCacheUsePolicy cacheUsePolicy /* = NodeCacheUsePolicy::UseCache */) const
137{
138 std::vector<uint8_t> bytes(numBytes);
139 ExecuteAndMapReturnCodes([&] {
141 m_backendHandle, static_cast<PEAK_NODE_CACHE_USE_POLICY>(cacheUsePolicy), bytes.data(), bytes.size());
142 });
143
144 return bytes;
145}
146
147inline void RegisterNode::Write(const std::vector<uint8_t>& bytes)
148{
149 ExecuteAndMapReturnCodes(
150 [&] { return PEAK_C_ABI_PREFIX PEAK_RegisterNode_Write(m_backendHandle, bytes.data(), bytes.size()); });
151}
152
153} /* namespace nodes */
154} /* namespace core */
155} /* namespace peak */
Represents a GenAPI node.
Definition peak_node.hpp:122
Represents a GenAPI register node.
Definition peak_register_node.hpp:37
~RegisterNode() override=default
size_t Length() const
Returns the length.
Definition peak_register_node.hpp:129
RegisterNode & operator=(RegisterNode &&other)=delete
RegisterNode & operator=(const RegisterNode &other)=delete
std::vector< uint8_t > Read(size_t numBytes, NodeCacheUsePolicy cacheUsePolicy=NodeCacheUsePolicy::UseCache) const
Reads a given amount of bytes.
Definition peak_register_node.hpp:135
RegisterNode(RegisterNode &&other)=delete
void Write(const std::vector< uint8_t > &bytes)
Writes a given amount of bytes.
Definition peak_register_node.hpp:147
RegisterNode(const RegisterNode &other)=delete
uint64_t Address() const
Returns the address.
Definition peak_register_node.hpp:122
NodeCacheUsePolicy
Definition peak_common_node_enums.hpp:25
The "peak" namespace directly contains convenience functionality like the DeviceManager as well as th...
Definition peak_dynamic_loader.h:32
struct PEAK_NODE * PEAK_NODE_HANDLE
Definition peak_backend.h:411
int32_t PEAK_NODE_CACHE_USE_POLICY
Definition peak_backend.h:225
PEAK_C_API PEAK_RegisterNode_GetAddress(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, uint64_t *address)
Asks the given register node for its address.
PEAK_C_API PEAK_RegisterNode_ToNode(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given register node to a node.
struct PEAK_REGISTER_NODE * PEAK_REGISTER_NODE_HANDLE
Definition peak_backend.h:435
PEAK_C_API PEAK_RegisterNode_GetLength(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, size_t *length)
Asks the given register node for its length.
PEAK_C_API PEAK_RegisterNode_Write(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, const uint8_t *bytesToWrite, size_t bytesToWriteSize)
Tells the given register node to write the given bytes.
PEAK_C_API PEAK_RegisterNode_Read(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, uint8_t *bytesToRead, size_t bytesToReadSize)
Tells the given register node to read the given amount of bytes.
#define PEAK_C_ABI_PREFIX
Definition peak_dll_defines.h:16