CVBpy 15.0
ValueNode Class Reference

Base class for all nodes, that have a value. More...

Inherits Node.

Inherited by BooleanNode, CategoryNode, CommandNode, EnumEntryNode, SelectorNode, and StringNode.

Public Member Functions

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_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

Base class for all nodes, that have a value.

Member Function Documentation

◆ from_string()

None from_string (   self,
str  value 
)

Sets the value of the node from the string value.

Parameters

value : str New value as a string.

◆ register_event_on_read_updated()

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

Registers a listener to node on read event.

Parameters

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

Returns

cvb.EventCookie Event cookie to manually unregister the listener.

◆ register_event_written_updated()

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

Registers a listener to node written event.

Parameters

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

Returns

cvb.EventCookie Event cookie to manually unregister the listener.

◆ unregister_event_on_read_updated()

None unregister_event_on_read_updated (   self,
cvb.EventCookie  event_cookie 
)

Manually unregister a listener from the node on read event.

Parameters

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

◆ unregister_event_written_updated()

None unregister_event_written_updated (   self,
cvb.EventCookie  event_cookie 
)

Manually unregister a listener from the node written event.

Parameters

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

Property Documentation

◆ is_streamable

is_streamable = property
static

bool: Gets whether this node should be used, when the camera settings are stared.

True if the node is streamable, otherwise false.

◆ polling_time

polling_time = property
static

int: Gets the polling time of this value in milliseconds.

If this node is not intended to be polled, a zero timespan is returned.