CVB.Net 15.0
Loading...
Searching...
No Matches

GenApi.BooleanNode that is configurable. More...

Inherits ValueNode.

Public Member Functions

 BooleanNode (string name)
 Creates a new BooleanNode with the given name .
 
 BooleanNode (string name, Namespace nameSpace)
 Creates a new BooleanNode with the given name and nameSpace .
 
override void FromString (string value)
 Sets this node's value from the string value .
 
override string ToString ()
 Gets the string representation of this node.
 
- 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.
 

Protected Member Functions

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.
 
override TimeSpan GetPollingTime ()
 Gets the polling time 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

long OffValue [get, set]
 Gets and sets the value to be written if IBooleanNode.Value is set to false.
 
long OnValue [get, set]
 Gets and sets the value to be written if IBooleanNode.Value is set to true.
 
bool Value [get, set]
 Gets/sets the value of this boolean node.
 
ValueVariant< IntegerBaseNode, long > ValueConfig [get, set]
 Gets and sets the value configuration of this boolean node.
 
- 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

- 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

GenApi.BooleanNode that is configurable.

Constructor & Destructor Documentation

◆ BooleanNode() [1/2]

BooleanNode ( string name)

Creates a new BooleanNode with the given name .

If the name does not contain a namespace prefix the Namespace.Custom is used.

You must add this node to a NodeMap before most operations are possible.

Parameters
nameName with optional namespace prefix.

◆ BooleanNode() [2/2]

BooleanNode ( string name,
Namespace nameSpace )

Creates a new BooleanNode with the given name and nameSpace .

You must add this node to a NodeMap before most operations are possible.

Parameters
nameNode name without namespace prefix.
nameSpaceNamespace to place the node in.

Member Function Documentation

◆ FromString()

override void FromString ( string value)

Sets this node's value from the string value .

Parameters
valueNew value as a string.

Implements IValueNode.

◆ GetAccessMode()

override AccessMode GetAccessMode ( )
protected

Gets the access mode by querying all ValueConfigs for it.

Returns
The effective access mode.

◆ GetCacheMode()

override CacheMode GetCacheMode ( )
protected

Gets the cache mode by querying all ValueConfigs for it.

Returns
The effective cache mode.

◆ GetPollingTime()

override TimeSpan GetPollingTime ( )
protected

Gets the polling time by querying all ValueConfigs for it.

Returns
The effective polling time.

◆ ToString()

override string ToString ( )

Gets the string representation of this node.

Returns
Same as Value.ToString.

Property Documentation

◆ OffValue

long OffValue
getset

Gets and sets the value to be written if IBooleanNode.Value is set to false.

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

◆ OnValue

long OnValue
getset

Gets and sets the value to be written if IBooleanNode.Value is set to true.

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

◆ ValueConfig

ValueVariant<IntegerBaseNode, long> ValueConfig
getset

Gets and sets the value configuration of this boolean node.

This defines whether this boolean stores the value or the value is referenced to another node.

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