CVB.Net 14.0
IntRegNode Class Reference

An int typed, configurable IRegisterNode. More...

Inherits IntegerBaseNode, and IConfigurableIntRegNode.

Inherited by Int32RegNode, and Int64RegNode.

Protected Member Functions

override void Dispose (bool disposing)
 IDispose helper function.
 
override AccessMode GetAccessMode ()
 Reads the access mode directly from this register node. More...
 
override CacheMode GetCacheMode ()
 Gets the current (dependent) cache mode of this node.
 
override TimeSpan GetPollingTime ()
 Gets the polling time for this node.
 
- Protected Member Functions inherited from SelectorNode
 SelectorNode (IntPtr handle)
 Creates this SelectorNode object. More...
 
override void Dispose (bool disposing)
 IDispose helper function.
 
- Protected Member Functions inherited from ValueNode
 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

override NodeMap NodeMap [get, set]
 Gets the INodeMap this node resides in.
 
new AccessMode AccessMode [get, set]
 Gets the GenApi.AccessMode of this node. More...
 
long Address [get]
 Gets the registers address. More...
 
ICollection< IntegerBaseNodeAddressNodes [get]
 Gets the collection of nodes which define the nodes address. More...
 
new CacheMode CacheMode [get, set]
 Gets or sets the caching mode of this register node. More...
 
ICollection< NodeInvalidatorNodes [get]
 Gets the collection of nodes which, when changed, invalidate this node's cache. More...
 
bool IsSigned [get, set]
 Gets or sets whether this integer register is signed. More...
 
long Length [get]
 Gets the number of bytes the register occupies. More...
 
new TimeSpan PollingTime [get, set]
 Gets or sets the polling time of this value. More...
 
- Properties inherited from IntegerBaseNode
long Increment [get]
 Gets the increment of this Value. More...
 
long Max [get]
 Gets the maximal allowed number for this Value.
 
long Min [get]
 Gets the minimal allowed number for this Value.
 
NumberRepresentation Representation [get, set]
 Gets or sets how the value is to be represented.
 
string Unit [get]
 Gets the unit of this node's value.
 
long Value [get, set]
 Gets/Sets the value of this integer node.
 
- Properties inherited from SelectorNode
override NodeMap NodeMap [get, set]
 Gets the INodeMap this node resides in.
 
bool IsSelector [get]
 Gets whether this node selects at least one other.
 
ICollection< ValueNodeSelectedNodes [get]
 Gets the collection of all nodes selected by this one. More...
 
- Properties inherited from ValueNode
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.
 
- Properties inherited from IConfigurableSelectorNode
new ICollection< IConfigurableValueNodeSelectedNodes [get]
 Gets the collection of all nodes selected by this one. More...
 
- Properties inherited from ISelectorNode
bool IsSelector [get]
 Gets whether this node selects at least one other.
 
IEnumerable< IValueNodeSelectedNodes [get]
 Gets all nodes selected by this one. More...
 
- Properties inherited from IConfigurableIntegerBaseNode
new NumberRepresentation Representation [get, set]
 Gets or sets how the value is to be represented.
 
- Properties inherited from IIntegerNode
long Value [get, set]
 Gets/Sets the value of this integer node.
 
long Min [get]
 Gets the minimal allowed number for this Value.
 
long Max [get]
 Gets the maximal allowed number for this Value.
 
long Increment [get]
 Gets the increment of this Value. More...
 
NumberRepresentation Representation [get]
 Gets how the value is to be represented.
 
string Unit [get]
 Gets the unit of this node's value.
 
- Properties inherited from IConfigurableIntRegNode
bool IsSigned [get, set]
 Gets or sets whether this integer register is signed. More...
 
- Properties inherited from IConfigurableRegisterNode
new AccessMode AccessMode [get, set]
 Gets or sets the GenApi.AccessMode of this node. More...
 
new CacheMode CacheMode [get, set]
 Gets or sets the caching mode of this register node. More...
 
new TimeSpan PollingTime [get, set]
 Gets or sets the polling time of this value. More...
 
ICollection< IConfigurableNodeInvalidatorNodes [get]
 Gets the collection of nodes which, when changed, invalidate this node's cache. More...
 
ICollection< IConfigurableIntegerBaseNodeAddressNodes [get]
 Gets the collection of nodes which define the nodes address. More...
 
- Properties inherited from IRegisterNode
long Address [get]
 Gets the registers address. More...
 
long Length [get]
 Gets the number of bytes the register occupies. More...
 

Additional Inherited Members

- Public Member Functions inherited from IntegerBaseNode
override void FromString (string value)
 Sets this node's value from the string value . More...
 
override string ToString ()
 Gets the string representation of this node. More...
 
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...
 
- 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...
 
- Events inherited from ValueNode
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...
 

Detailed Description

An int typed, configurable IRegisterNode.

Member Function Documentation

◆ GetAccessMode()

override AccessMode GetAccessMode ( )
protectedvirtual

Reads the access mode directly from this register node.

Returns
The current access mode.

Implements Node.

Property Documentation

◆ AccessMode

new AccessMode AccessMode
getset

Gets the GenApi.AccessMode of this node.

Set operation is only possible as long as the GevServer.GevServer.State is GevServerState.Configuration.

Implements IConfigurableRegisterNode.

◆ Address

long Address
get

Gets the registers address.

Attention: the register address may change dependent on selecting nodes or other states.

Implements IRegisterNode.

◆ AddressNodes

ICollection<IntegerBaseNode> AddressNodes
get

Gets the collection of nodes which define the nodes address.

This collection does not contain the address constant from the creation of the node; only the additional nodes for dynamic addresses. The IRegisterNode.Address property is the sum of the initial address constant and the current values of the nodes of this collection.

Change is only possible as long as the GevServer.GevServer.State is GevServerState.Configuration.

Collection containing all address nodes.

Implements IConfigurableRegisterNode.

◆ CacheMode

new CacheMode CacheMode
getset

Gets or sets the caching mode of this register node.

Set operation is only possible as long as the GevServer.GevServer.State is GevServerState.Configuration.

Implements IConfigurableRegisterNode.

◆ InvalidatorNodes

ICollection<Node> InvalidatorNodes
get

Gets the collection of nodes which, when changed, invalidate this node's cache.

Change is only possible as long as the GevServer.GevServer.State is GevServerState.Configuration.

Collection containing all invalidator nodes.

Implements IConfigurableRegisterNode.

◆ IsSigned

bool IsSigned
getset

Gets or sets whether this integer register is signed.

Set operation is only possible as long as the GevServer.GevServer.State is GevServerState.Configuration.

Implements IConfigurableIntRegNode.

◆ Length

long Length
get

Gets the number of bytes the register occupies.

Length of the register's memory in bytes.

Implements IRegisterNode.

◆ PollingTime

new TimeSpan PollingTime
getset

Gets or sets 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/set.

Implements IConfigurableRegisterNode.