Interface SpinnakerNET::GenApi::IEnum¶

ClassList > SpinnakerNET > GenApi > IEnum

Enumeration interface only containing enumeration methods.

#include <Enumeration.h>

Inherits the following classes: SpinnakerNET::GenApi::IValue

Inherited by the following classes: SpinnakerNET::GenApi::Enumeration

Public Attributes¶

Type	Name
property array< EnumEntry^>	Entries = `/* multi line expression /` Gets all supported enum entries.*
property array<::System::String^>	Symbolics = `/* multi line expression /` Gets all available enum entry names.*
property EnumValue	Value = `/* multi line expression /` Gets or sets the value of this enumeration as an integer or string.*

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
IEnumEntry __clrcall	GetEntryByName (::System::String ^ name) Gets an enumeration entry node by name.
void __clrcall	set (EnumValue value)

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

See SpinnakerNET::GenApi::IValue

Type	Name
void __clrcall	FromString (System::String ^ value) Sets the value in this `Node` to the value given in__value .

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.

Public Attributes Documentation¶

variable Entries¶

Gets all supported enum entries.

property array<EnumEntry^> SpinnakerNET::GenApi::IEnum::Entries;

EnumEntry array containing all entries; null if no entries are present.

variable Symbolics¶

Gets all available enum entry names.

property array<::System::String^> SpinnakerNET::GenApi::IEnum::Symbolics;

System.System::String array containing all entries; null if no entries are present.

variable Value¶

Gets or sets the value of this enumeration as an integer or string.

property EnumValue SpinnakerNET::GenApi::IEnum::Value;

EnumValue object to handle both integer and string values in a convenient way.

Public Functions Documentation¶

function GetEntryByName¶

Gets an enumeration entry node by name.

IEnumEntry  __clrcall SpinnakerNET::GenApi::IEnum::GetEntryByName (
    ::System::String ^ name
)

Parameters:

name Name of the enumeration entry node.

function set¶

void  __clrcall SpinnakerNET::GenApi::IEnum::set (
    EnumValue value
)

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