CVB.Net 14.0
ValueNode Class Reference

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

Inherits Node, and IValueNode.

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

Public Member Functions

virtual void FromString (string value)
 Sets the value of this node from the string value . More...
 
override string ToString ()
 Returns this node's value as a string representation. More...
 
void Invalidate ()
 Invalidates the values of this node. More...
 
- Public Member Functions inherited from Node
void Dispose ()
 Disposes the native object wrapped by this object immediately. More...
 
void Close ()
 Alias of the Dispose() method. More...
 
void FromString (string value)
 Sets this node's value from the string value . More...
 

Properties

ReadWriteVerify VerifyMode [get, set]
 Gets/sets how the read/write of values in this node is verified.
 
TimeSpan PollingTime [get]
 Gets the polling time of this value. More...
 
bool IsStreamable [get]
 Returns whether this node should be used when saving camera settings.
 
bool IsSelected [get]
 Gets whether this value is selected by at least one other node. More...
 
IEnumerable< SelectorNodeSelectingNodes [get]
 Gets all nodes selecting this node. More...
 
- Properties inherited from Node
bool IsDisposed [get]
 Tests whether the native handle has been disposed.
 
IntPtr Handle [get]
 Native CVB NODE handle. More...
 
NodeMap NodeMap [get]
 Gets the GenApi.NodeMap this node resides in.
 
string Name [get]
 Gets the full name of this node. More...
 
string ToolTip [get]
 Gets the short descriptive text of this node. More...
 
string Description [get]
 Gets the long descriptive text of this node. More...
 
AccessMode AccessMode [get]
 Gets the GenApi.AccessMode of this node.
 
bool IsImplemented [get]
 AccessMode helper to check whether this node is implemented.
 
bool IsAvailable [get]
 AccessMode helper to check whether this node is available.
 
bool IsReadable [get]
 AccessMode helper to check whether this node is readable.
 
bool IsWritable [get]
 AccessMode helper to check whether this node is writable.
 
CacheMode CacheMode [get]
 Gets the cache mode of this node. More...
 
string EventID [get]
 Nodes with an event identifier may become invalidated, if an event / message is delivered from the device.
 
bool IsFeature [get]
 Returns whether this node is considered a feature node. More...
 
bool IsDeprecated [get]
 Gets whether this node is considered deprecated. More...
 
Visibility Visibility [get]
 Gets the complexity level of this node. More...
 
Node AliasNode [get]
 Gets the node, that is an alias value for this node. More...
 
- Properties inherited from INativeHandle
IntPtr Handle [get]
 The native handle of the object.
 
bool IsDisposed [get]
 Possibility to check whether the object has already been disposed of.
 
- Properties inherited from INode
INodeMap NodeMap [get]
 Gets the INodeMap this node resides in.
 
string Name [get]
 Gets the full name of this node. More...
 
string ToolTip [get]
 Gets the short descriptive text of this node. More...
 
string Description [get]
 Gets the long descriptive text of this node. More...
 
AccessMode AccessMode [get]
 Gets the GenApi.AccessMode of this node.
 
bool IsImplemented [get]
 AccessMode helper to check whether this node is implemented.
 
bool IsAvailable [get]
 AccessMode helper to check whether this node is available.
 
bool IsReadable [get]
 AccessMode helper to check whether this node is readable.
 
bool IsWritable [get]
 AccessMode helper to check whether this node is writable.
 
CacheMode CacheMode [get]
 Gets the cache mode of this node. More...
 
string EventID [get]
 Nodes with an event identifier may become invalidated if an event/message is delivered from the device.
 
bool IsFeature [get]
 Gets whether this node is considered a feature node. More...
 
bool IsDeprecated [get]
 Gets whether this node is considered deprecated. More...
 
Visibility Visibility [get]
 Gets the complexity level of this node. More...
 
INode AliasNode [get]
 Gets the node that is an alias value for this node. More...
 
- Properties inherited from IValueNode
TimeSpan PollingTime [get]
 Gets the polling time of this value. More...
 
bool IsStreamable [get]
 Gets whether this node should be used when the camera settings are stored.
 

Additional Inherited Members

- Protected Member Functions inherited from Node
void Detach ()
 Detaches this Image object from the native object. More...
 
virtual void Dispose (bool disposing)
 IDispose helper function. More...
 
- Protected Attributes inherited from Node
readonly IntPtr UpdatedCallbackID
 Identifier of the registered updated callback.
 
- Events inherited from Node
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method. More...
 
EventHandler Updated
 Event signaling that a node property has been updated. More...
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
More...
 

Detailed Description

Base class for all Nodes, that have a value.

Member Function Documentation

◆ FromString()

virtual void FromString ( string  value)
virtual

Sets the value of this node from the string value .

Parameters
valueNew value as a string.

Implements IValueNode.

Reimplemented in CategoryNode, and EnumEntryNode.

◆ Invalidate()

void Invalidate ( )

Invalidates the values of this node.

Invalidate deletes all caches for all nodes on which this node depends (value, min, max, increment,...).

◆ ToString()

override string ToString ( )

Returns this node's value as a string representation.

Returns
Value as a string.

Property Documentation

◆ IsSelected

bool IsSelected
get

Gets whether this value is selected by at least one other node.

For information about selected Nodes see the SelectorNode.

◆ PollingTime

TimeSpan PollingTime
get

Gets the polling time of this value.

If this node is not intended to be polled, TimeSpan.Zero is returned.

Implements IValueNode.

◆ SelectingNodes

IEnumerable<SelectorNode> SelectingNodes
get

Gets all nodes selecting this node.

For information about selected Nodes see the SelectorNode.

Enumerator for enumerating all selecting nodes.