Basic GenApi node for device feature access. More...

Inherited by NodeRef, PortNode, and ValueNode.

Public Member Functions
void	Dispose ()
	Disposes the native object wrapped by this object immediately. More...

void	Close ()
	Alias of the Dispose() method. More...

Protected Member Functions
void	Detach ()
	Detaches this Image object from the native object. More...

virtual void	Dispose (bool disposing)
	IDispose helper function. More...

Protected Attributes
readonly IntPtr	UpdatedCallbackID
	Identifier of the registered updated callback.

Properties
bool	IsDisposed `[get]`
	Tests whether the native handle has been disposed.

IntPtr	Handle `[get]`
	Native CVB NODE handle. More...

NodeMap	NodeMap `[get]`
	Gets the GenApi.NodeMap 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]`
	Returns 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...

Node	AliasNode `[get]`
	Gets the node, that is an alias value for this node. 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 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...

Events
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method. More...

EventHandler	Updated
	Event signaling that a node property has been updated. More...

Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method. More...

Detailed Description

Basic GenApi node for device feature access.

Member Function Documentation

◆ Close()

void Close ( )

Alias of the Dispose() method.

Call this method to release the resources allocated by this node immediately. Remember that after calling Dispose, any subsequent access to references to this image will result in an ObjectDisposedException.

◆ Detach()

void Detach ( )

protected

Detaches this Image object from the native object.

This call marks this object as disposed without changing the underlying ref-count.

◆ Dispose() [1/2]

void Dispose ( )

Disposes the native object wrapped by this object immediately.

Call this method to release the resources allocated by this node immediately. Remember that after calling Dispose, any subsequent access to references to this image will result in an ObjectDisposedException.

◆ Dispose() [2/2]

virtual void Dispose ( bool disposing )

protectedvirtual

IDispose helper function.

Parameters

disposing true when called via IDisposable.Dispose, false when called by the finalizer.

Property Documentation

◆ AliasNode

Node AliasNode

get

Gets the node, that is an alias value for this node.

Alias nodes give an additional view on a value or can contain summary information for e.g. CategoryNodes.

Alias node instance; null for none.

Implements INode.

◆ CacheMode

CacheMode CacheMode

get

Gets the cache mode of this node.

For non-register nodes the cache mode of the register in the value path of the node chain up the the register is used.

Implements INode.

◆ Description

string Description

get

Gets the long descriptive text of this node.

See ToolTip for the short description.

Implements INode.

◆ Handle

IntPtr Handle

get

Native CVB NODE handle.

It is normally not necessary to work with this handle in CVB.Net. Note that using this handle in connection with the legacy CVB managed wrappers may actually be disruptive to your application.

Implements INativeHandle.

◆ IsDeprecated

bool IsDeprecated

get

Gets whether this node is considered deprecated.

Deprecated nodes are only available because of backward compatibility. New applications should not use these features.

Implements INode.

◆ IsFeature

bool IsFeature

get

Returns whether this node is considered a feature node.

Feature nodes are in a way public / user interface nodes. All nodes, that are directly referenced by the Root CategoryNode or indirectly via other CategoryNodes that are children of Root, are considered features.

Implements INode.

◆ Name

string Name

get

Gets the full name of this node.

String containing the namespace of the node (Std or Cust and the node name separated by double colons (::)).

Implements INode.

◆ ToolTip

string ToolTip

get

Gets the short descriptive text of this node.

See Description for the long description.

Implements INode.

◆ Visibility

Visibility Visibility

get

Gets the complexity level of this node.

For additional information on the different levels see the Stemmer.Cvb.GenApi.Visibility documentation.

Implements INode.

Event Documentation

◆ ObjectDisposing

NativeHandleEventDelegate ObjectDisposing

Raised when this object is about to be disposed via the IDisposable.Dispose method.

This event is raised right before this object is disposed. The dispose itself cannot be canceled.

◆ Updated

EventHandler Updated

Event signaling that a node property has been updated.

Updates range


Contact Legal Privacy Statement	Copyright © 2023.
	All rights reserved.

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ Close()

◆ Detach()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

Property Documentation

◆ AliasNode

◆ CacheMode

◆ Description

◆ Handle

◆ IsDeprecated

◆ IsFeature

◆ Name

◆ ToolTip

◆ Visibility

Event Documentation

◆ ObjectDisposing

◆ Updated