Basic GenApi node for device feature access.
More...
#include <cvb/genapi/node.hpp>
Inherited by PortNode, RegisterNode, and ValueNode.
Basic GenApi node for device feature access.
- Example
-
◆ AccessMode()
Gets the access mode of this node.
- Returns
- Current access mode.
- Exceptions
-
◆ AliasNode()
Gets the node, that is an alias value for this node.
- Returns
- pointer to alias node instance; null pointer for none.
- Exceptions
-
Alias nodes give an additional view on a value or can contain summary information for e.g. CategoryNodes.
◆ CacheMode()
Gets the cache mode of this node.
- Returns
- The current cache mode.
- Exceptions
-
For non-register nodes the cache mode of the register in the value path of the node chain up the the register is used.
◆ Description()
Gets the long descriptive text of this node.
- Returns
- Long descriptive text.
- Exceptions
-
See ToolTip() for the short description.
◆ DisplayName()
Gets the display name of this node.
- Returns
- Display name including namespace.
- Exceptions
-
String containing the name to display.
◆ EventID()
Nodes with an event identifier may become invalidated, if an event / message is delivered from the device.
- Returns
- The event ID as string.
- Exceptions
-
◆ Handle()
Classic API node handle.
- Returns
- Classic API handle.
- Exceptions
-
Does | not throw any exception. |
It is normally not necessary to work with this handle.
◆ IsAvailable()
bool IsAvailable |
( |
| ) |
const |
|
inline |
Helper to check whether this node is available.
- Returns
- True if the node is available, otherwise false.
- Exceptions
-
◆ IsDeprecated()
bool IsDeprecated |
( |
| ) |
const |
|
inline |
Gets whether this node is considered deprecated.
- Returns
- True if the node is deprecated, otherwise false.
- Exceptions
-
Deprecated nodes are only available because of backward compatibility. New applications should not use these features.
◆ IsFeature()
Returns whether this node is considered a feature node.
- Returns
- True if the node is a feature node, otherwise false.
- Exceptions
-
Feature nodes are in a way public / user interface nodes. All nodes, that are directly referenced by the root node or other CategoryNodes, are considered features.
◆ IsImplemented()
bool IsImplemented |
( |
| ) |
const |
|
inline |
Helper to check whether this node is implemented.
- Returns
- True if the node is implemented, otherwise false.
- Exceptions
-
◆ IsReadable()
bool IsReadable |
( |
| ) |
const |
|
inline |
Helper to check whether this node is readable.
- Returns
- True if the node is readable, otherwise false.
- Exceptions
-
◆ IsWriteable()
bool IsWriteable |
( |
| ) |
const |
|
inline |
Helper to check whether this node is writable.
- Returns
- True if the node is writable, otherwise false.
- Exceptions
-
◆ Name()
Gets the full name of this node.
- Returns
- Name including namespace.
- Exceptions
-
String containing the namespace of the node (Std or Cust and the node name separated by double colons (::)).
◆ NodeMap()
Gets the node map this node resides in.
- Returns
- A constant pointer to the node map.
- Exceptions
-
Does | not throw any exception. |
◆ RegisterEventUpdated()
Register a listener to node updated event.
- Parameters
-
[in] | handler | Listener to node updated event. |
- Returns
- Event cookie to manually unregister the listener.
- Exceptions
-
◆ ToolTip()
Gets the short descriptive text of this node.
- Returns
- The tool tip text.
- Exceptions
-
◆ UnregisterEventUpdated()
Manually unregister a listener to the node updated event.
- Parameters
-
[in] | eventCookie | eventCookie Event cookie, obtained from registering the listener. |
- Exceptions
-
Does | not throw any exception. |
◆ Visibility()
Gets the complexity level of this node.
- Returns
- The visibility of this node.
- Exceptions
-