Class SpinnakerNET::GenApi::Node¶

ClassList > SpinnakerNET > GenApi > Node

Base class of allGenApi feature nodes.

#include <Node.h>

Inherits the following classes: SpinnakerNET::GenApi::INode

Inherited by the following classes: SpinnakerNET::GenApi::BoolNode, SpinnakerNET::GenApi::Category, SpinnakerNET::GenApi::Command, SpinnakerNET::GenApi::EnumEntry, SpinnakerNET::GenApi::Enumeration, SpinnakerNET::GenApi::Float, SpinnakerNET::GenApi::Integer, SpinnakerNET::GenApi::PortNode, SpinnakerNET::GenApi::Register, SpinnakerNET::GenApi::StringNode

Public Attributes¶

Type	Name
property SpinnakerNET::GenApi::AccessMode	AccessMode = `/* multi line expression /` Gets the* `AccessMode` for this`Node` .
property SpinnakerNET::GenApi::INode	Alias = `/* multi line expression /` Gets all the node that represents the same value in a different way.*
property SpinnakerNET::GenApi::CachingMode	CachingMode = `/* multi line expression /` Gets the* `CachingMode` of this node.
property array< SpinnakerNET::GenApi::INode ^>	Children = `/* multi line expression /` Gets all child nodes.*
property System::String	Description = `/* multi line expression /` Gets the descriptive text of this node.*
property System::String	DisplayName = `/* multi line expression /` Gets the name which is to be displayed in a UI.*
property bool	Disposed = `/* multi line expression /` Gets or sets whether this* `Node` has been disposed.
property System::String	EventID = `/* multi line expression /` Gets the event ID of the event this node is associated with.*
property array< SpinnakerNET::GenApi::INode ^>	InvalidatingChildren = `/* multi line expression /` Gets all child nodes.*
property bool	IsAvailable = `/* multi line expression /` Gets whether this* `Node` is available.
property bool	IsCachable = `/* multi line expression /` Gets whether this node is cacheable.*
property bool	IsFeature = `/* multi line expression /` Gets whether this node is a feature.*
property bool	IsImplemented = `/* multi line expression /` Gets whether this* `Node` is implemented.
property bool	IsReadable = `/* multi line expression /` Gets whether this* `Node` is readable.
property bool	IsRegister = `/* multi line expression /` Gets whether this* `Node` is a register node.
property bool	IsSelector = `/* multi line expression /` Gets whether this node is a selector node.*
property bool	IsStreamable = `/* multi line expression /` Gets whether this node is intended to be savable or loadable.*
property bool	IsWritable = `/* multi line expression /` Gets whether this* `Node` is writable.
property array< SpinnakerNET::GenApi::INode ^>	LockNodes = `/* multi line expression /` Gets all locked nodes.*
property System::String	Name = `/* multi line expression /` Gets the short name of this node.*
property SpinnakerNET::GenApi::NameSpace	NameSpace = `/* multi line expression /` Gets the namespace this node resides in.*
property SpinnakerNET::GenApi::NodeMap	NodeMap = `/* multi line expression /` Gets or sets the* `NodeMap` of this`Node` .
property array< SpinnakerNET::GenApi::INode ^>	Parents = `/* multi line expression /` Gets all locked nodes.*
property __int64	PollingTime = `/* multi line expression /` Gets the time when this node should be reread (invalidated).*
property System::String	QualifiedName = `/* multi line expression /` Gets the full name of this node.*
property array< SpinnakerNET::GenApi::IValue^>	SelectedFeatures = `/* multi line expression /` Gets all feature nodes which are affected by this selected node.*
property array< SpinnakerNET::GenApi::IValue^>	SelectingFeatures = `/* multi line expression /` Gets all selector nodes which select this feature.*
property System::String	ToolTip = `/* multi line expression /` Gets the tool-tip of this node.*
property SpinnakerNET::GenApi::Visibility	Visibility = `/* multi line expression /` Gets the* `Visibility` of this node.

Public Attributes inherited from SpinnakerNET::GenApi::INode¶

See SpinnakerNET::GenApi::INode

Type	Name
property SpinnakerNET::GenApi::INode	Alias = `/* multi line expression /` Gets all the node that represents the same value in a different way.*
property SpinnakerNET::GenApi::CachingMode	CachingMode = `/* multi line expression /` Gets the* `CachingMode` of this node.
property array< SpinnakerNET::GenApi::INode ^>	Children = `/* multi line expression /` Gets all child nodes.*
property System::String	Description = `/* multi line expression /` Gets the descriptive text of this node.*
property System::String	DisplayName = `/* multi line expression /` Gets the name which is to be displayed in a UI.*
property System::String	EventID = `/* multi line expression /` Gets the event ID of the event this node is associated with.*
property bool	IgnoreCache Gets or sets whether this `Node` should be read ignoring any caches.
property array< SpinnakerNET::GenApi::INode ^>	InvalidatingChildren = `/* multi line expression /` Gets all InvalidatingChildren nodes.*
property bool	IsAvailable = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is available.
property bool	IsCachable = `/* multi line expression /` Gets whether this node is cacheable.*
property bool	IsFeature = `/* multi line expression /` Gets whether this node is a supported feature.*
property bool	IsImplemented = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is implemented.
property bool	IsReadable = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is readable.
property bool	IsRegister = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is a register node.
property bool	IsStreamable = `/* multi line expression /` Gets whether this node is intended to be savable or loadable.*
property bool	IsWritable = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is writable.
property array< SpinnakerNET::GenApi::INode ^>	LockNodes = `/* multi line expression /` Gets all locked nodes.*
property System::String	Name = `/* multi line expression /` Gets the short name of this node.*
property SpinnakerNET::GenApi::NameSpace	NameSpace = `/* multi line expression /` Gets the namespace this node resides in.*
property SpinnakerNET::GenApi::NodeMap	NodeMap = `/* multi line expression /` Gets the* `NodeMap` of this`Node` .
property array< SpinnakerNET::GenApi::INode ^>	Parents = `/* multi line expression /` Gets all InvalidatingChildren nodes.*
property __int64	PollingTime = `/* multi line expression /` Gets the time when this node should be reread (invalidated).*
property System::Collections::Generic::Dictionary< System::String^, Property^>	Properties = `/* multi line expression /` Gets all properties set during initialization. These are the underlying feature node connections.*
property System::String	QualifiedName = `/* multi line expression /` Gets the full name of this node.*
property System::String	ToolTip = `/* multi line expression /` Gets the tool-tip of this node.*
event NodeEventHandler	Updated Event for notification on status changes.
property bool	VerifyRead Gets or sets whether this `Node` should verify the values being read.
property bool	VerifyWrite Gets or sets whether this `Node` should verify the values being written.
property SpinnakerNET::GenApi::Visibility	Visibility = `/* multi line expression /` Gets the* `Visibility` of this node.

Public Attributes inherited from SpinnakerNET::GenApi::ISelector¶

See SpinnakerNET::GenApi::ISelector

Type	Name
property bool	IsSelector = `/* multi line expression /` Gets whether this node is a selector node.*
property array< SpinnakerNET::GenApi::IValue^>	SelectedFeatures = `/* multi line expression /` Gets all feature nodes which are affected by this selected node.*
property array< SpinnakerNET::GenApi::IValue^>	SelectingFeatures = `/* multi line expression /` Gets all selector nodes which select this feature.*

Public Attributes inherited from SpinnakerNET::GenApi::IBase¶

See SpinnakerNET::GenApi::IBase

Type	Name
property SpinnakerNET::GenApi::AccessMode	AccessMode = `/* multi line expression /` Gets the* `AccessMode` for the`Node` .

Public Functions¶

Type	Name
virtual void __clrcall	ImposeAccessMode (SpinnakerNET::GenApi::AccessMode accessMode) Overwrites the XML access mode of this node.
virtual void __clrcall	ImposeVisibility (SpinnakerNET::GenApi::Visibility visibility) Overwrites the XML visibility of this node.
virtual void __clrcall	Invalidate (void) Invalidates the node so that the value is reread from the device.
virtual bool __clrcall	IsVisible (SpinnakerNET::GenApi::Visibility reference) Gets whether this `Node` is visible compared to the__reference visibility.
__clrcall	Node (NodeMap ^ map, System::IntPtr handle) Initializes all member fields of this `Node` as a top level node.
virtual __clrcall	~Node (void) Destroys this `Node` and frees managed and unmanaged resources.

Public Functions inherited from SpinnakerNET::GenApi::INode¶

See SpinnakerNET::GenApi::INode

Type	Name
void __clrcall	ImposeAccessMode (SpinnakerNET::GenApi::AccessMode accessMode) Overwrites the XML access mode of this node.
void __clrcall	ImposeVisibility (SpinnakerNET::GenApi::Visibility visibility) Overwrites the XML visibility of this node.
void __clrcall	Invalidate (void) Invalidates the node so that the value is reread from the device.
bool __clrcall	IsVisible (SpinnakerNET::GenApi::Visibility reference) Gets whether this `Node` is visible compared to the__reference visibility.

Protected Attributes¶

Type	Name
property System::IntPtr	Handle = `/* multi line expression /` Gets or sets the handle to the unmanaged* `GenApi::INode` object.
property bool	IgnoreCache Gets or sets whether this `Node` should be read ignoring any caches.
property System::Collections::Generic::Dictionary< System::String^, Property^>	Properties = `/* multi line expression /` Gets all properties set during initialization. These are the underlying feature node connections.*
event NodeEventHandler	Updated = `/* multi line expression /` Event for notification on status changes.*
property bool	VerifyRead Gets or sets whether this `Node` should verify the values being read.
property bool	VerifyWrite Gets or sets whether this `Node` should verify the values being written.

Protected Functions¶

Type	Name
virtual void __clrcall	CheckStatus (void) Checks if the object status is valid (not disposed and node map valid).
virtual void	raise (SpinnakerNET::GenApi::INode ^ node)
virtual void	remove (NodeEventHandler ^ handler)
void __clrcall	set (SpinnakerNET::GenApi::NodeMap ^ map)
void __clrcall	set (bool disposed)
void __clrcall	set (System::IntPtr handle)

Public Attributes Documentation¶

variable AccessMode¶

Gets the AccessMode for thisNode .

virtual property SpinnakerNET::GenApi::AccessMode SpinnakerNET::GenApi::Node::AccessMode;

GenICam.GenApi.AccessMode of this Node.

variable Alias¶

Gets all the node that represents the same value in a different way.

virtual property SpinnakerNET::GenApi::INode SpinnakerNET::GenApi::Node::Alias;

Node with different representation; null if no alias is present.

variable CachingMode¶

Gets the CachingMode of this node.

virtual property SpinnakerNET::GenApi::CachingMode SpinnakerNET::GenApi::Node::CachingMode;

GenICam.GenApi.CachingMode of this node.

variable Children¶

Gets all child nodes.

virtual property array<SpinnakerNET::GenApi::INode ^> SpinnakerNET::GenApi::Node::Children;

Node array containing all child nodes.

variable Description¶

Gets the descriptive text of this node.

virtual property System::String SpinnakerNET::GenApi::Node::Description;

System.System::String containing the long description.

variable DisplayName¶

Gets the name which is to be displayed in a UI.

virtual property System::String SpinnakerNET::GenApi::Node::DisplayName;

System.System::String containing the display name

variable Disposed¶

Gets or sets whether this Node has been disposed.

virtual property bool SpinnakerNET::GenApi::Node::Disposed;

true if this Node has been disposed; false otherwise.

variable EventID¶

Gets the event ID of the event this node is associated with.

virtual property System::String SpinnakerNET::GenApi::Node::EventID;

System.System::String containing the event id if the node is associated with one.

variable InvalidatingChildren¶

Gets all child nodes.

virtual property array<SpinnakerNET::GenApi::INode ^> SpinnakerNET::GenApi::Node::InvalidatingChildren;

Node array containing all child nodes.

variable IsAvailable¶

Gets whether this Node is available.

virtual property bool SpinnakerNET::GenApi::Node::IsAvailable;

true if this Node is available; false otherwise.

variable IsCachable¶

Gets whether this node is cacheable.

virtual property bool SpinnakerNET::GenApi::Node::IsCachable;

true if this node is cacheable.

variable IsFeature¶

Gets whether this node is a feature.

virtual property bool SpinnakerNET::GenApi::Node::IsFeature;

true if this node is streamable.

variable IsImplemented¶

Gets whether this Node is implemented.

virtual property bool SpinnakerNET::GenApi::Node::IsImplemented;

true if this Node is implemented; false otherwise.

variable IsReadable¶

Gets whether this Node is readable.

virtual property bool SpinnakerNET::GenApi::Node::IsReadable;

true if this Node is readable; false otherwise.

variable IsRegister¶

Gets whether this Node is a register node.

virtual property bool SpinnakerNET::GenApi::Node::IsRegister;

true if this Node implements the GenApi::IRegister interface; false otherwise.

variable IsSelector¶

Gets whether this node is a selector node.

property bool SpinnakerNET::GenApi::Node::IsSelector;

true if this node supports the GenApi::ISelector interface; false otherwise.

variable IsStreamable¶

Gets whether this node is intended to be savable or loadable.

virtual property bool SpinnakerNET::GenApi::Node::IsStreamable;

true if this node is streamable.

variable IsWritable¶

Gets whether this Node is writable.

virtual property bool SpinnakerNET::GenApi::Node::IsWritable;

true if this Node is writable; false otherwise.

variable LockNodes¶

Gets all locked nodes.

virtual property array<SpinnakerNET::GenApi::INode ^> SpinnakerNET::GenApi::Node::LockNodes;

Node array containing all locked nodes.

variable Name¶

Gets the short name of this node.

virtual property System::String SpinnakerNET::GenApi::Node::Name;

System.System::String containing the short name.

variable NameSpace¶

Gets the namespace this node resides in.

virtual property SpinnakerNET::GenApi::NameSpace SpinnakerNET::GenApi::Node::NameSpace;

SpinnakerNET::GenApi::NameSpace enum.

variable NodeMap¶

Gets or sets the NodeMap of thisNode .

virtual property SpinnakerNET::GenApi::NodeMap SpinnakerNET::GenApi::Node::NodeMap;

NodeMap object.

variable Parents¶

Gets all locked nodes.

virtual property array<SpinnakerNET::GenApi::INode ^> SpinnakerNET::GenApi::Node::Parents;

Node array containing all locked nodes.

variable PollingTime¶

Gets the time when this node should be reread (invalidated).

virtual property __int64 SpinnakerNET::GenApi::Node::PollingTime;

long containing the recommended polling time in us for this node.

variable QualifiedName¶

Gets the full name of this node.

virtual property System::String SpinnakerNET::GenApi::Node::QualifiedName;

System.System::String containing the full name.

variable SelectedFeatures¶

Gets all feature nodes which are affected by this selected node.

property array<SpinnakerNET::GenApi::IValue^> SpinnakerNET::GenApi::Node::SelectedFeatures;

Array containing nodes which change on index change.

variable SelectingFeatures¶

Gets all selector nodes which select this feature.

property array<SpinnakerNET::GenApi::IValue^> SpinnakerNET::GenApi::Node::SelectingFeatures;

Array of selector nodes which select this feature.

Gets the tool-tip of this node.

virtual property System::String SpinnakerNET::GenApi::Node::ToolTip;

System.System::String containing the short description.

variable Visibility¶

Gets the Visibility of this node.

virtual property SpinnakerNET::GenApi::Visibility SpinnakerNET::GenApi::Node::Visibility;

GenICam.GenApi.Visibility of this node.

Public Functions Documentation¶

function ImposeAccessMode¶

Overwrites the XML access mode of this node.

virtual void  __clrcall SpinnakerNET::GenApi::Node::ImposeAccessMode (
    SpinnakerNET::GenApi::AccessMode accessMode
)

Parameters:

accessMode New access mode of this node.

Implements SpinnakerNET::GenApi::INode::ImposeAccessMode

function ImposeVisibility¶

Overwrites the XML visibility of this node.

virtual void  __clrcall SpinnakerNET::GenApi::Node::ImposeVisibility (
    SpinnakerNET::GenApi::Visibility visibility
)

Parameters:

visibility New visibility of this node.

Implements SpinnakerNET::GenApi::INode::ImposeVisibility

function Invalidate¶

Invalidates the node so that the value is reread from the device.

virtual void  __clrcall SpinnakerNET::GenApi::Node::Invalidate (
    void
)

Implements SpinnakerNET::GenApi::INode::Invalidate

function IsVisible¶

Gets whether this Node is visible compared to the__reference visibility.

virtual bool  __clrcall SpinnakerNET::GenApi::Node::IsVisible (
    SpinnakerNET::GenApi::Visibility reference
)

Parameters:

reference Reference visibility to compare to.

Returns:

true if this Node is visible; false otherwise.

Implements SpinnakerNET::GenApi::INode::IsVisible

function Node¶

Initializes all member fields of this Node as a top level node.

__clrcall SpinnakerNET::GenApi::Node::Node (
    NodeMap ^ map,
    System::IntPtr handle
)

Parameters:

map SpinnakerNET::GenApi::NodeMap which holds this node.
handle GenApi::INode handle from which this Node is built.

function ~Node¶

Destroys this Node and frees managed and unmanaged resources.

virtual __clrcall SpinnakerNET::GenApi::Node::~Node (
    void
)

Protected Attributes Documentation¶

variable Handle¶

Gets or sets the handle to the unmanaged GenApi::INode object.

virtual property System::IntPtr SpinnakerNET::GenApi::Node::Handle;

Pointer to the unmanaged GenApi::INode object.

variable IgnoreCache¶

Gets or sets whether this Node should be read ignoring any caches.

virtual property bool SpinnakerNET::GenApi::Node::IgnoreCache;

true if this Node is read ignoring any caches; false otherwise.

variable Properties¶

Gets all properties set during initialization. These are the underlying feature node connections.

virtual property System::Collections::Generic::Dictionary<System::String^,Property^> SpinnakerNET::GenApi::Node::Properties;

A Dictionary with the property name as its key and another Dictionary containing value/attribute pairs as its value.

variable Updated¶

Event for notification on status changes.

event NodeEventHandler SpinnakerNET::GenApi::Node::Updated;

variable VerifyRead¶

Gets or sets whether this Node should verify the values being read.

virtual property bool SpinnakerNET::GenApi::Node::VerifyRead;

true if this Node has to verify read data; false otherwise.

variable VerifyWrite¶

Gets or sets whether this Node should verify the values being written.

virtual property bool SpinnakerNET::GenApi::Node::VerifyWrite;

true if this Node has to verify written data; false otherwise.

Protected Functions Documentation¶

function CheckStatus¶

Checks if the object status is valid (not disposed and node map valid).

virtual void  __clrcall SpinnakerNET::GenApi::Node::CheckStatus (
    void
)

function raise¶

virtual void SpinnakerNET::GenApi::Node::raise (
    SpinnakerNET::GenApi::INode ^ node
)

function remove¶

virtual void SpinnakerNET::GenApi::Node::remove (
    NodeEventHandler ^ handler
)

function set [1/3]¶

void  __clrcall SpinnakerNET::GenApi::Node::set (
    SpinnakerNET::GenApi::NodeMap ^ map
)

function set [2/3]¶

void  __clrcall SpinnakerNET::GenApi::Node::set (
    bool disposed
)

function set [3/3]¶

void  __clrcall SpinnakerNET::GenApi::Node::set (
    System::IntPtr handle
)

The documentation for this class was generated from the following file /workspace/src/SpinnakerNET/GenApiNet/Node.h

Class SpinnakerNET::GenApi::Node¶

Public Attributes¶

Public Attributes inherited from SpinnakerNET::GenApi::INode¶

Public Attributes inherited from SpinnakerNET::GenApi::ISelector¶

Public Attributes inherited from SpinnakerNET::GenApi::IBase¶

Public Functions¶

Public Functions inherited from SpinnakerNET::GenApi::INode¶

Protected Attributes¶

Protected Functions¶

Public Attributes Documentation¶

variable AccessMode¶

variable Alias¶

variable CachingMode¶

variable Children¶

variable Description¶

variable DisplayName¶

variable Disposed¶

variable EventID¶

variable InvalidatingChildren¶

variable IsAvailable¶

variable IsCachable¶

variable IsFeature¶

variable IsImplemented¶

variable IsReadable¶

variable IsRegister¶

variable IsSelector¶

variable IsStreamable¶

variable IsWritable¶

variable LockNodes¶

variable Name¶

variable NameSpace¶

variable NodeMap¶

variable Parents¶

variable PollingTime¶

variable QualifiedName¶

variable SelectedFeatures¶

variable SelectingFeatures¶

variable ToolTip¶

variable Visibility¶

Public Functions Documentation¶

function ImposeAccessMode¶

function ImposeVisibility¶

function Invalidate¶

function IsVisible¶

function Node¶

function ~Node¶

Protected Attributes Documentation¶

variable Handle¶

variable IgnoreCache¶

variable Properties¶

variable Updated¶

variable VerifyRead¶

variable VerifyWrite¶

Protected Functions Documentation¶

function CheckStatus¶

function raise¶

function remove¶

function set [1/3]¶

function set [2/3]¶

function set [3/3]¶