CVB++ 14.0
RegisterNode Class Reference

Untyped register access (only memory). More...

#include <cvb/genapi/register_node.hpp>

Inherits Node.

Public Member Functions

std::int64_t Address () const
 Gets the registers address. More...
 
std::int64_t Length () const
 Gets the number of bytes occupied by the register. More...
 
- Public Member Functions inherited from Node
void * Handle () const noexcept
 Classic API node handle. More...
 
String Name () const
 Gets the full name of this node. More...
 
String DisplayName () const
 Gets the display name of this node. More...
 
String ToolTip () const
 Gets the short descriptive text of this node. More...
 
String Description () const
 Gets the long descriptive text of this node. More...
 
Cvb::GenApi::AccessMode AccessMode () const
 Gets the access mode of this node. More...
 
bool IsImplemented () const
 Helper to check whether this node is implemented. More...
 
bool IsAvailable () const
 Helper to check whether this node is available. More...
 
bool IsReadable () const
 Helper to check whether this node is readable. More...
 
bool IsWriteable () const
 Helper to check whether this node is writable. More...
 
Cvb::GenApi::CacheMode CacheMode () const
 Gets the cache mode of this node. More...
 
String EventID () const
 Nodes with an event identifier may become invalidated, if an event / message is delivered from the device. More...
 
bool IsFeature () const
 Returns whether this node is considered a feature node. More...
 
bool IsDeprecated () const
 Gets whether this node is considered deprecated. More...
 
Cvb::GenApi::Visibility Visibility () const
 Gets the complexity level of this node. More...
 
NodePtr AliasNode () const
 Gets the node, that is an alias value for this node. More...
 
EventCookie RegisterEventUpdated (std::function< void(Node &)> handler)
 Register a listener to node updated event. More...
 
void UnregisterEventUpdated (EventCookie eventCookie) noexcept
 Manually unregister a listener to the node updated event. More...
 
NodeMapPtr NodeMap () const noexcept
 Gets the node map this node resides in. More...
 

Detailed Description

Untyped register access (only memory).

Use the PortNode for reading/writing memory. Address() and Length() can be queried via this node.

Member Function Documentation

◆ Address()

std::int64_t Address ( ) const
inline

Gets the registers address.

Returns
The address.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Length()

std::int64_t Length ( ) const
inline

Gets the number of bytes occupied by the register.

Returns
The number of bytes.
Exceptions
Anyexception derived from std::exception including CvbException.