Interface SpinnakerNET::GenApi::INode¶

ClassList > SpinnakerNET > GenApi > INode

#include <Node.h>

Inherits the following classes: SpinnakerNET::GenApi::ISelector

Inherited by the following classes: SpinnakerNET::GenApi::IValue, SpinnakerNET::GenApi::Node

Public Attributes¶

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

Public Attributes Documentation¶

variable Alias¶

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

property SpinnakerNET::GenApi::INode SpinnakerNET::GenApi::INode::Alias;

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

variable CachingMode¶

Gets the CachingMode of this node.

property SpinnakerNET::GenApi::CachingMode SpinnakerNET::GenApi::INode::CachingMode;

GenICam.GenApi.CachingMode of this node.

variable Children¶

Gets all child nodes.

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

Node array containing all child nodes.

variable Description¶

Gets the descriptive text of this node.

property System::String SpinnakerNET::GenApi::INode::Description;

System.System::String containing the long description.

variable DisplayName¶

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

property System::String SpinnakerNET::GenApi::INode::DisplayName;

System.System::String containing the display name

variable EventID¶

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

property System::String SpinnakerNET::GenApi::INode::EventID;

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

variable IgnoreCache¶

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

property bool SpinnakerNET::GenApi::INode::IgnoreCache;

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

variable InvalidatingChildren¶

Gets all InvalidatingChildren nodes.

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

Node array containing all child nodes.

variable IsAvailable¶

Gets whether this Node is available.

property bool SpinnakerNET::GenApi::INode::IsAvailable;

true if this Node is available; false otherwise.

variable IsCachable¶

Gets whether this node is cacheable.

property bool SpinnakerNET::GenApi::INode::IsCachable;

true if this node is cacheable.

variable IsFeature¶

Gets whether this node is a supported feature.

property bool SpinnakerNET::GenApi::INode::IsFeature;

true if this node is streamable.

variable IsImplemented¶

Gets whether this Node is implemented.

property bool SpinnakerNET::GenApi::INode::IsImplemented;

true if this Node is implemented; false otherwise.

variable IsReadable¶

Gets whether this Node is readable.

property bool SpinnakerNET::GenApi::INode::IsReadable;

true if this Node is readable; false otherwise.

variable IsRegister¶

Gets whether this Node is a register node.

property bool SpinnakerNET::GenApi::INode::IsRegister;

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

variable IsStreamable¶

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

property bool SpinnakerNET::GenApi::INode::IsStreamable;

true if this node is streamable.

variable IsWritable¶

Gets whether this Node is writable.

property bool SpinnakerNET::GenApi::INode::IsWritable;

true if this Node is writable; false otherwise.

variable LockNodes¶

Gets all locked nodes.

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

Node array containing all locked nodes.

variable Name¶

Gets the short name of this node.

property System::String SpinnakerNET::GenApi::INode::Name;

System.System::String containing the short name.

variable NameSpace¶

Gets the namespace this node resides in.

property SpinnakerNET::GenApi::NameSpace SpinnakerNET::GenApi::INode::NameSpace;

SpinnakerNET::GenApi::NameSpace enum.

variable NodeMap¶

Gets the NodeMap of thisNode .

property SpinnakerNET::GenApi::NodeMap SpinnakerNET::GenApi::INode::NodeMap;

NodeMap object.

variable Parents¶

Gets all InvalidatingChildren nodes.

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

Node array containing all child nodes.

variable PollingTime¶

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

property __int64 SpinnakerNET::GenApi::INode::PollingTime;

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

variable Properties¶

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

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

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

variable QualifiedName¶

Gets the full name of this node.

property System::String SpinnakerNET::GenApi::INode::QualifiedName;

System.System::String containing the full name.

Gets the tool-tip of this node.

property System::String SpinnakerNET::GenApi::INode::ToolTip;

System.System::String containing the short description.

variable Updated¶

Event for notification on status changes.

event NodeEventHandler SpinnakerNET::GenApi::INode::Updated;

variable VerifyRead¶

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

property bool SpinnakerNET::GenApi::INode::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.

property bool SpinnakerNET::GenApi::INode::VerifyWrite;

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

variable Visibility¶

Gets the Visibility of this node.

property SpinnakerNET::GenApi::Visibility SpinnakerNET::GenApi::INode::Visibility;

GenICam.GenApi.Visibility of this node.

Public Functions Documentation¶

function ImposeAccessMode¶

Overwrites the XML access mode of this node.

void  __clrcall SpinnakerNET::GenApi::INode::ImposeAccessMode (
    SpinnakerNET::GenApi::AccessMode accessMode
)

Parameters:

accessMode New access mode of this node.

function ImposeVisibility¶

Overwrites the XML visibility of this node.

void  __clrcall SpinnakerNET::GenApi::INode::ImposeVisibility (
    SpinnakerNET::GenApi::Visibility visibility
)

Parameters:

visibility New visibility of this node.

function Invalidate¶

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

void  __clrcall SpinnakerNET::GenApi::INode::Invalidate (
    void
)

function IsVisible¶

Gets whether this Node is visible compared to the__reference visibility.

bool  __clrcall SpinnakerNET::GenApi::INode::IsVisible (
    SpinnakerNET::GenApi::Visibility reference
)

Parameters:

reference Reference visibility to compare to.

Returns:

true if this Node is visible; false otherwise.

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

Interface SpinnakerNET::GenApi::INode¶

Public Attributes¶

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

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

Public Functions¶

Public Attributes Documentation¶

variable Alias¶

variable CachingMode¶

variable Children¶

variable Description¶

variable DisplayName¶

variable EventID¶

variable IgnoreCache¶

variable InvalidatingChildren¶

variable IsAvailable¶

variable IsCachable¶

variable IsFeature¶

variable IsImplemented¶

variable IsReadable¶

variable IsRegister¶

variable IsStreamable¶

variable IsWritable¶

variable LockNodes¶

variable Name¶

variable NameSpace¶

variable NodeMap¶

variable Parents¶

variable PollingTime¶

variable Properties¶

variable QualifiedName¶

variable ToolTip¶

variable Updated¶

variable VerifyRead¶

variable VerifyWrite¶

variable Visibility¶

Public Functions Documentation¶

function ImposeAccessMode¶

function ImposeVisibility¶

function Invalidate¶

function IsVisible¶