CVB.Net 14.0
ValueNode Class Referenceabstract

Node having a value. More...

Inherits Node, and IConfigurableValueNode.

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

Public Member Functions

abstract void FromString (string value)
 Sets the value of the node from the string value . More...
 
- Public Member Functions inherited from Node
void Dispose ()
 Disposes the native object wrapped by this object immediately. More...
 
void FromString (string value)
 Sets this node's value from the string value . More...
 

Protected Member Functions

 ValueNode (IntPtr handle)
 Creates the ValueNode. More...
 
override void Dispose (bool disposing)
 Additionally disposes of the registered events. More...
 
abstract TimeSpan GetPollingTime ()
 Gets the polling time for this node. More...
 
int OnRead ()
 Calls the Read event and returns the ErrorCodes to deliver to the native server. More...
 
int OnWritten ()
 Calls the Written event and returns the ErrorCodes to deliver to the native server. More...
 
- Protected Member Functions inherited from Node
 Node (IntPtr handle)
 Creates a node from the given handle . More...
 
virtual void Dispose (bool disposing)
 IDispose helper function. More...
 
abstract AccessMode GetAccessMode ()
 Implementation for getting the access mode. More...
 
abstract CacheMode GetCacheMode ()
 Gets the current (dependent) cache mode of this node. More...
 

Properties

virtual bool IsStreamable [get, set]
 Gets or sets whether this node should be used, when the camera settings are stored.
 
TimeSpan PollingTime [get]
 Gets the polling time of this value. More...
 
- Properties inherited from Node
IntPtr Handle [get]
 Native CVB GevServer Node handle. More...
 
bool IsDisposed [get]
 Tests whether the native handle has been disposed.
 
virtual NodeMap NodeMap [get, set]
 Gets the parent Cvb.GevServer.NodeMap of this GevServerNode. More...
 
string ToolTip [get, set]
 Gets or sets the short descriptive text of this node. More...
 
string Description [get, set]
 Gets or sets the long descriptive text of this node. More...
 
AccessMode AccessMode [get]
 Gets the GenApi.AccessMode of this node.
 
AccessModeImposedAccessMode [get, set]
 Overrides the node's default AccessMode. More...
 
IntegerBaseNode IsImplementedConfig [get, set]
 Gets or sets the node that specifies whether a node is implemented in the device or not. More...
 
IntegerBaseNode IsAvailableConfig [get, set]
 Gets or sets the node that specifies whether a node is currently available or not. More...
 
IntegerBaseNode IsLockedConfig [get, set]
 Gets or sets the node that specifies whether a node is currently read only or not. More...
 
CacheMode CacheMode [get]
 Gets the cache mode of this node. More...
 
Visibility Visibility [get, set]
 Gets or sets the complexity level of this node. More...
 
Node AliasNode [get, set]
 Gets or sets the node that is an alias value for this node. More...
 
string Name [get]
 Gets the full name of this node. More...
 
Namespace Namespace [get]
 Gets the namespace this node is in. More...
 
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.
 
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...
 
- 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 IConfigurableNode
new string ToolTip [get, set]
 Gets or sets the short descriptive text of this node. More...
 
new string Description [get, set]
 Gets or sets the long descriptive text of this node. More...
 
AccessModeImposedAccessMode [get, set]
 Overrides the node's default AccessMode. More...
 
new Visibility Visibility [get, set]
 Gets or sets the complexity level of this node. More...
 
new IConfigurableNode AliasNode [get, set]
 Gets or sets the node that is an alias value for this node. More...
 
IConfigurableIntegerBaseNode IsImplementedConfig [get, set]
 Gets or sets the node that specifies whether a node is implemented in the device or not. More...
 
IConfigurableIntegerBaseNode IsAvailableConfig [get, set]
 Gets or sets the node that specifies whether a node is currently available or not. More...
 
IConfigurableIntegerBaseNode IsLockedConfig [get, set]
 Gets or sets the node that specifies whether a node is currently read only or not. More...
 
- 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 IConfigurableValueNode
new bool IsStreamable [get, set]
 Gets or sets whether this node should be used when the camera settings are stored.
 
- 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.
 

Events

EventHandler< ReplyStatusEventArgsRead
 This event is fired when the client reads a value. More...
 
EventHandler< ReplyStatusEventArgsWritten
 This event is fired when the client has written a value.
 
- Events inherited from Node
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method. More...
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from Node
static Namespace ParseNamespace (string name)
 Gets the Namespace from the given name . More...
 
static string ParseName (string name)
 Gets the name part of the given node name . More...
 
static string EnsureNodeNameOnly (string name)
 Throws if the given name has a namespace prefix. More...
 

Detailed Description

Node having a value.

Constructor & Destructor Documentation

◆ ValueNode()

ValueNode ( IntPtr  handle)
protected

Creates the ValueNode.

Parameters
handleNative GevServer node handle.

Member Function Documentation

◆ Dispose()

override void Dispose ( bool  disposing)
protectedvirtual

Additionally disposes of the registered events.

Parameters
disposingtrue if called from IDisposable.Dispose; false if called by finalizer.

Reimplemented from Node.

◆ FromString()

abstract void FromString ( string  value)
pure virtual

Sets the value of the node from the string value .

Parameters
valueNew value as a string.

Implements IValueNode.

Implemented in BooleanNode, CategoryNode, CommandNode, EnumEntryNode, EnumerationNode, FloatBaseNode, IntegerBaseNode, and StringNode.

◆ GetPollingTime()

abstract TimeSpan GetPollingTime ( )
protectedpure virtual

Gets the polling time for this node.

Returns
Polling time; TimeSpan.Zero if not intended to be polled.

Implemented in BooleanNode, CategoryNode, CommandNode, EnumEntryNode, EnumerationNode, FloatNode, FloatRegNode, IntegerNode, IntRegNode, IntSwissKnifeNode, StringNode, and StringRegNode.

◆ OnRead()

int OnRead ( )
protected

Calls the Read event and returns the ErrorCodes to deliver to the native server.

Returns

◆ OnWritten()

int OnWritten ( )
protected

Calls the Written event and returns the ErrorCodes to deliver to the native server.

Returns

Property Documentation

◆ PollingTime

TimeSpan PollingTime
get

Gets the polling time of this value.

Attention: here only this node is directly queried and not also the nodes it depends on! This differs from the GenApi implementation.

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

Implements IValueNode.

Event Documentation

◆ Read

EventHandler<ReplyStatusEventArgs> Read

This event is fired when the client reads a value.

You can set a value to this ValueNode and the result will be delivered to the client.