CommandNode Class Reference

GenApi.CommandNode that is configurable. More...

Inherits ValueNode, IConfigurableCommandNode, and IHasValueConfig< TNode, TValue >.

Public Member Functions
	CommandNode (string name)
	Creates a new CommandNode with the given name . More...
	CommandNode (string name, Namespace nameSpace)
	Creates a new CommandNode with the given name and nameSpace . More...
void	Execute ()
	Executes this command.
override void	FromString (string value)
	Executes if value is "true". More...
override string	ToString ()
	Gets the IsDone status as a string. 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...
void	Execute ()
	Executes this command.

Protected Member Functions
override AccessMode	GetAccessMode ()
	Gets the access mode by querying all ValueConfigs for it. More...
override CacheMode	GetCacheMode ()
	Gets the cache mode by querying all ValueConfigs for it. More...
override TimeSpan	GetPollingTime ()
	Gets the polling time for this node.
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 bool	IsStreamable [get, set]
	Commands are never streamable.
bool	IsDone [get]
	If this command is readable, the execution state can be queried.
new TimeSpan	PollingTime [get, set]
	Gets or sets the polling time of this value. More...
ValueVariant< IntegerBaseNode, long >	CommandConfig [get, set]
	Gets and sets the command value configuration of this command node. More...
ValueVariant< IntegerBaseNode, long >	ValueConfig [get, set]
	Gets and sets the value configuration of this command node. 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.
AccessMode?	ImposedAccessMode [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...
AccessMode?	ImposedAccessMode [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 IConfigurableCommandNode
new TimeSpan	PollingTime [get, set]
	Gets or sets the polling time of this value. More...
ValueVariant< IConfigurableIntegerBaseNode, long >	CommandConfig [get, set]
	Gets and sets the command value configuration of this command node. More...
ValueVariant< IConfigurableIntegerBaseNode, long >	ValueConfig [get, set]
	Gets and sets the value configuration of this command node. More...
Properties inherited from ICommandNode
bool	IsDone [get]
	If this command is readable, the execution state can be queried.

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...
Events inherited from ValueNode
EventHandler< ReplyStatusEventArgs >	Read
	This event is fired when the client reads a value. More...
EventHandler< ReplyStatusEventArgs >	Written
	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

GenApi.CommandNode that is configurable.

Constructor & Destructor Documentation

CommandNode() [1/2]

CommandNode

(

string

name

)

Creates a new CommandNode 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

name	Name with optional namespace prefix.

CommandNode() [2/2]

CommandNode	(	string	name,
		Namespace	nameSpace
	)

Creates a new CommandNode with the given name and nameSpace .

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

Parameters

name	Node name without namespace prefix.
nameSpace	Namespace to place the node in.

Member Function Documentation

FromString()

override void FromString ( string  value )

virtual

Executes if value is "true".

Parameters

value

"true" to execute.

Implements ValueNode.

GetAccessMode()

override AccessMode GetAccessMode ( )

protectedvirtual

Gets the access mode by querying all ValueConfigs for it.

Returns

The effective access mode.

Implements Node.

GetCacheMode()

override CacheMode GetCacheMode ( )

protectedvirtual

Gets the cache mode by querying all ValueConfigs for it.

Returns

The effective cache mode.

Implements Node.

ToString()

override string ToString

(

)

Gets the IsDone status as a string.

Returns

"true" if is done.

Property Documentation

CommandConfig

ValueVariant<IntegerBaseNode, long> CommandConfig

getset

Gets and sets the command value configuration of this command node.

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

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

Implements IConfigurableCommandNode.

PollingTime

new TimeSpan PollingTime

getset

Gets or sets the polling time of this value.

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

Implements IConfigurableCommandNode.

ValueConfig

ValueVariant<IntegerBaseNode, long> ValueConfig

getset

Gets and sets the value configuration of this command node.

This defines whether this command 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 GevServer.State.

Implements IConfigurableCommandNode.