Node Class Reference

Basic GenApi node for device feature access. More...

Inherits object.

Inherited by PortNode, RegisterNode, and ValueNode.

Public Member Functions
cvb.EventCookie	register_event_updated (self, Callable[[cvb.Node], None] handler)
	Register a listener to node updated event. More...
None	unregister_event_updated (self, cvb.EventCookie event_cookie)
	Manually unregister a listener to the node updated event. More...

Properties
	access_mode = property
	int: Gets the access mode of this node (see cvb.AccessMode). More...
	alias_node = property
	Union[cvb.BooleanNode, cvb.CategoryNode, cvb.CommandNode, cvb.EnumEntryNode, cvb.EnumerationNode, cvb.FloatNode, cvb.FloatRegNode, cvb.IntRegNode, cvb.IntegerNode, cvb.Node, cvb.PortNode, cvb.RegisterNode, cvb.SelectorNode, cvb.StringNode, cvb.StringRegNode, cvb.ValueNode]: Gets the node, that is an alias value for this node. More...
	cache_mode = property
	int: Gets the cache mode of this node (see cvb.CacheMode). More...
	description = property
	str: Gets the long descriptive text of this node. More...
	display_name = property
	str: Gets the display name of this node. More...
	event_id = property
	str: Nodes with an event identifier may become invalidated, if an event / message is delivered from the device. More...
	is_available = property
	bool: Helper to check whether this node is available. More...
	is_deprecated = property
	bool: Gets whether this node is considered deprecated. More...
	is_feature = property
	bool: Returns whether this node is considered a feature node. More...
	is_implemented = property
	bool: Helper to check whether this node is implemented. More...
	is_readable = property
	bool: Helper to check whether this node is readable. More...
	is_writeable = property
	bool: Helper to check whether this node is writable. More...
	name = property
	str: Gets the full name of this node. More...
	tool_tip = property
	str: Gets the short descriptive text of this node. More...
	visibility = property
	int: Gets the complexity level of this node. More...

Detailed Description

Basic GenApi node for device feature access.

Member Function Documentation

register_event_updated()

cvb.EventCookie register_event_updated	(		self,
		Callable[[cvb.Node], None]	handler
	)

Register a listener to node updated event.

Parameters

handler : Callable[[cvb.Node], None] Listener to node updated event.

Returns

cvb.EventCookie Event cookie to manually unregister the listener.

unregister_event_updated()

None unregister_event_updated	(		self,
		cvb.EventCookie	event_cookie
	)

Manually unregister a listener to the node updated event.

Parameters

event_cookie : cvb.EventCookie Event cookie, obtained from registering the listener.

Property Documentation

access_mode

access_mode = property

static

int: Gets the access mode of this node (see cvb.AccessMode).

alias_node

alias_node = property

static

Union[cvb.BooleanNode, cvb.CategoryNode, cvb.CommandNode, cvb.EnumEntryNode, cvb.EnumerationNode, cvb.FloatNode, cvb.FloatRegNode, cvb.IntRegNode, cvb.IntegerNode, cvb.Node, cvb.PortNode, cvb.RegisterNode, cvb.SelectorNode, cvb.StringNode, cvb.StringRegNode, cvb.ValueNode]: Gets the node, that is an alias value for this node.

Alias nodes give an additional view on a value or can contain summary information for for example CategoryNodes.

cache_mode

cache_mode = property

static

int: Gets the cache mode of this node (see cvb.CacheMode).

description

description = property

static

str: Gets the long descriptive text of this node.

See tool_tip() for the short description.

display_name

display_name = property

static

str: Gets the display name of this node.

String containing the name to display.

event_id

event_id = property

static

str: Nodes with an event identifier may become invalidated, if an event / message is delivered from the device.

is_available

is_available = property

static

bool: Helper to check whether this node is available.

is_deprecated

is_deprecated = property

static

bool: Gets whether this node is considered deprecated.

Deprecated nodes are only available because of backward compatibility. New applications should not use these features.

is_feature

is_feature = property

static

bool: Returns whether this node is considered a feature node.

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.

is_implemented

is_implemented = property

static

bool: Helper to check whether this node is implemented.

is_readable

is_readable = property

static

bool: Helper to check whether this node is readable.

is_writeable

is_writeable = property

static

bool: Helper to check whether this node is writable.

name

name = property

static

str: Gets the full name of this node.

String containing the namespace of the node (Std or Cust and the node name separated by double colons (::)).

tool_tip

tool_tip = property

static

str: Gets the short descriptive text of this node.

visibility

visibility = property

static

int: Gets the complexity level of this node.