CVBpy 15.0
Node Class Reference

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

Inherits object.

Inherited by ValueNode.

Public Member Functions

None add (self, cvb.gevserver.Node node, int kind)
 Adds a node to this node. More...
 
cvb.EventCookie register_event_updated (self, Callable[[cvb.gevserver.Node], None] handler)
 Register a listener to node updated event. More...
 
bool remove (self, cvb.gevserver.Node node, int kind)
 Removes a node from this node. 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).
 
 alias_node = property
 cvb.gevserver.Node: Gets or sets 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 or sets the long descriptive text of this node. More...
 
 display_name = property
 str: Gets or sets 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.
 
 imposed_access_mode = property
 int: Gets or sets the default access mode of this node (see cvb.AccessMode). More...
 
 is_available_config = property
 cvb.gevserver.IntegerBaseNode: Gets or sets the node that specifies whether a node is currently available or not. More...
 
 is_deprecated = property
 bool: Gets whether this node is considered deprecated. More...
 
 is_feature = property
 bool: Gets whether this node is considered a feature node. More...
 
 is_implemented = property
 bool: Gets whether the node is implemented.
 
 is_implemented_config = property
 cvb.gevserver.IntegerBaseNode: Gets or sets the node that specifies whether a node is implemented in the device or not. More...
 
 is_locked_config = property
 cvb.gevserver.IntegerBaseNode: Gets or sets the node that specifies whether a node is currently read only or not. More...
 
 is_readable = property
 bool: Helper to check whether this node is readable.
 
 is_writable = property
 bool: Helper to check whether this node is writable.
 
 name = property
 str: Gets the full name of this node. More...
 
 name_only = property
 str: Gets the full name of this node without namespace. More...
 
 name_space = property
 int: Gets the namespace this node is in (see cvb.gevserver.NameSpace). More...
 
 node_map = property
 cvb.gevserver.NodeMap: Gets the node map of this GevServer node.
 
 tool_tip = property
 str: Gets or sets the short descriptive text of this node. More...
 
 visibility = property
 int: Gets the complexity level of this node (see cvb.Visibility).
 

Detailed Description

Basic GevServer node for device feature access.

Member Function Documentation

◆ add()

None add (   self,
cvb.gevserver.Node  node,
int  kind 
)

Adds a node to this node.

Parameters

node : cvb.gevserver.Node Node to add.

kind : int Kind of node.

◆ register_event_updated()

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

Register a listener to node updated event.

Parameters

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

Returns

cvb.EventCookie Event cookie, to manually unregister the listener.

◆ remove()

bool remove (   self,
cvb.gevserver.Node  node,
int  kind 
)

Removes a node from this node.

Parameters

node : cvb.gevserver.Node Node to remove.

kind : int Kind of node to remove.

Returns

bool True if the node was removed, otherwise false.

◆ 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

◆ alias_node

alias_node = property
static

cvb.gevserver.Node: Gets or sets 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).

For non-register nodes the cache mode of the register in the value path of the node chain up the register is used.

◆ description

description = property
static

str: Gets or sets the long descriptive text of this node.

See tool_tip for the short description.

◆ display_name

display_name = property
static

str: Gets or sets the display name of this node.

String containing the name to display.

◆ imposed_access_mode

imposed_access_mode = property
static

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

Imposed access mode; empty shell if no imposing is done or set to clear.

◆ is_available_config

is_available_config = property
static

cvb.gevserver.IntegerBaseNode: Gets or sets the node that specifies whether a node is currently available or not.

Set operation is only possible as long as the cvb.gevserver.State is cvb.gevserver.State.Configuration.

◆ 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: Gets 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 category nodes are considered features.

◆ is_implemented_config

is_implemented_config = property
static

cvb.gevserver.IntegerBaseNode: Gets or sets the node that specifies whether a node is implemented in the device or not.

Set operation is only possible as long as the cvb.gevserver.State is cvb.gevserver.State.Configuration.

◆ is_locked_config

is_locked_config = property
static

cvb.gevserver.IntegerBaseNode: Gets or sets the node that specifies whether a node is currently read only or not.

Set operation is only possible as long as the cvb.gevserver.State is cvb.gevserver.State.Configuration.

◆ 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's name separated by double colons (::)).

◆ name_only

name_only = property
static

str: Gets the full name of this node without namespace.

String of the node's name without namespace.

◆ name_space

name_space = property
static

int: Gets the namespace this node is in (see cvb.gevserver.NameSpace).

cvb.gevserver.NameSpace.Private nodes will not be in the GenApi XML description.

◆ tool_tip

tool_tip = property
static

str: Gets or sets the short descriptive text of this node.

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