CVBpy 15.0
CommandNode Class Reference

A node that can be executed. More...

Inherits ValueNode.

Public Member Functions

None command_config_as_int (self, int value)
 Sets an integer that determines this node's command value. More...
 
None command_config_as_node (cvb.gevserver.IntegerBaseNode node)
 Sets a node that determines this node's command value. More...
 
cvb.gevserver.CommandNode create (str name, Optional[int] namespace)
 Creates a new command node. More...
 
None execute (self)
 Executes this command.
 
- Public Member Functions inherited from ValueNode
None from_string (self, str value)
 Sets the value of the node from the string value. More...
 
cvb.EventCookie register_event_on_read_updated (self, Callable[[cvb.gevserver.Node], None] handler)
 Registers a listener to node on read event. More...
 
cvb.EventCookie register_event_written_updated (self, Callable[[cvb.gevserver.Node], None] handler)
 Registers a listener to node written event. More...
 
None unregister_event_on_read_updated (self, cvb.EventCookie event_cookie)
 Manually unregister a listener from the node on read event. More...
 
None unregister_event_written_updated (self, cvb.EventCookie event_cookie)
 Manually unregister a listener from the node written event. More...
 
- Public Member Functions inherited from Node
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

 is_done = property
 bool: If this command is readable, the execution state can be queried.
 
 value_config_as_int = property
 int: Gets or sets the integer that determines this node's value. More...
 
 value_config_as_node = property
 cvb.gevserver.IntegerBaseNode: Gets or sets the node that determines this node's value. More...
 
- Properties inherited from ValueNode
 is_streamable = property
 bool: Gets whether this node should be used, when the camera settings are stared. More...
 
 polling_time = property
 int: Gets the polling time of this value in milliseconds. More...
 
- Properties inherited from Node
 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

A node that can be executed.

Member Function Documentation

◆ command_config_as_int()

None command_config_as_int (   self,
int  value 
)

Sets an integer that determines this node's command value.

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

Parameters

value : int An integer to be set as command value configuration.

◆ command_config_as_node()

None command_config_as_node ( cvb.gevserver.IntegerBaseNode  node)

Sets a node that determines this node's command value.

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

Parameters

node : cvb.gevserver.IntegerBaseNode A node to be set as command value configuration.

◆ create()

cvb.gevserver.CommandNode create ( str  name,
Optional[int]  namespace 
)

Creates a new command node.

The node can be created using only the name with namespace or using the name only and an extra namespace parameter. You must add this node to a node map before most operations are possible.

Parameters

name : str Node name with or without namespace prefix. If the name does not contain a namespace prefix and no namespace is specified separately, cvb.gevserver.NameSpace.Custom is used.

namespace : Optional[int] Namespace to place the node in if not part of the name (see cvb.gevserver.NameSpace).

Returns

cvb.gevserver.CommandNode The requested node.

Property Documentation

◆ value_config_as_int

value_config_as_int = property
static

int: Gets or sets the integer that determines this node's value.

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

◆ value_config_as_node

value_config_as_node = property
static

cvb.gevserver.IntegerBaseNode: Gets or sets the node that determines this node's value.

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