CVB.Net 15.0
Loading...
Searching...
No Matches
StringRegNode Class Reference

StringNode that is a register. More...

Inherits StringNode, and IConfigurableRegisterNode.

Protected Member Functions

override void Dispose (bool disposing)
 IDispose helper function.
Parameters
disposingtrue when called via IDisposable.Dispose, false when called by the finalizer.

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

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.
 
long Address [get]
 Gets the registers address.
 
ICollection< IntegerBaseNodeAddressNodes [get]
 Gets the collection of nodes which define the nodes address.
 
new CacheMode CacheMode [get, set]
 Gets or sets the caching mode of this register node.
 
ICollection< NodeInvalidatorNodes [get]
 Gets the collection of nodes which, when changed, invalidate this node's cache.
 
long Length [get]
 Gets the number of bytes the register occupies.
 
new TimeSpan PollingTime [get, set]
 Gets or sets the polling time of this value.
 
- Properties inherited from StringNode
virtual ValueVariant< StringNode, string > ValueConfig [get, set]
 Gets and sets the value configuration of this string node.
 
string Value [get, set]
 Gets/sets the string value.
 
- 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.
 
- Properties inherited from Node
IntPtr Handle [get]
 Native CVB GevServer Node handle.
 
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.
 
string ToolTip [get, set]
 Gets or sets the short descriptive text of this node.
 
string Description [get, set]
 Gets or sets the long descriptive text of this node.
 
AccessMode AccessMode [get]
 Gets the GenApi.AccessMode of this node.
 
AccessModeImposedAccessMode [get, set]
 Overrides the node's default AccessMode.
 
IntegerBaseNode IsImplementedConfig [get, set]
 Gets or sets the node that specifies whether a node is implemented in the device or not.
 
IntegerBaseNode IsAvailableConfig [get, set]
 Gets or sets the node that specifies whether a node is currently available or not.
 
IntegerBaseNode IsLockedConfig [get, set]
 Gets or sets the node that specifies whether a node is currently read only or not.
 
CacheMode CacheMode [get]
 Gets the cache mode of this node.
 
Visibility Visibility [get, set]
 Gets or sets the complexity level of this node.
 
Node AliasNode [get, set]
 Gets or sets the node that is an alias value for this node.
 
string Name [get]
 Gets the full name of this node.
 
Namespace Namespace [get]
 Gets the namespace this node is in.
 
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.
 
bool IsDeprecated [get]
 Gets whether this node is considered deprecated.
 

Additional Inherited Members

- Public Member Functions inherited from StringNode
 StringNode (string name)
 Creates a new StringNode with the given name .
 
 StringNode (string name, Namespace nameSpace)
 Creates a new StringNode with the given name and nameSpace .
 
override void FromString (string value)
 Same as assigning to Value .
 
override string ToString ()
 Returns Value.
 
- Public Member Functions inherited from ValueNode
void FromString (string value)
 Sets the value of the node from the string value .
 
- Public Member Functions inherited from Node
void Dispose ()
 Disposes the native object wrapped by this object immediately.
 
- Static Protected Member Functions inherited from Node
static Namespace ParseNamespace (string name)
 Gets the Namespace from the given name .
 
static string ParseName (string name)
 Gets the name part of the given node name .
 
static string EnsureNodeNameOnly (string name)
 Throws if the given name has a namespace prefix.
 
- Events inherited from ValueNode
EventHandler< ReplyStatusEventArgsRead
 This event is fired when the client reads a value.
 
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.
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
 

Detailed Description

StringNode that is a register.

Member Function Documentation

◆ GetAccessMode()

override AccessMode GetAccessMode ( )
protected

Reads the access mode directly from this register node.

Returns
The current access mode.

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 INode.

◆ 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 INode.

◆ 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.

◆ 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 IValueNode.