Class SpinnakerNET::GenApi::Enumeration¶

ClassList > SpinnakerNET > GenApi > Enumeration

Node class representing an enumeration value.

#include <Enumeration.h>

Inherits the following classes: SpinnakerNET::GenApi::Node, SpinnakerNET::GenApi::IEnum

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::Node¶

See SpinnakerNET::GenApi::Node

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 Attributes inherited from SpinnakerNET::GenApi::IEnum¶

See SpinnakerNET::GenApi::IEnum

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
__clrcall	Enumeration (SpinnakerNET::GenApi::NodeMap ^ map, IntPtr handle) Initializes all member fields of this `Enumeration` __
__clrcall	Enumeration (SpinnakerNET::GenApi::INode ^ obj) Creates an `Enumeration` from a`Node` object when possible.
virtual void __clrcall	FromString (::System::String ^ value) Called by the `Node.FromString` method to parse the given__value . If the parsing succeeds the value is written to this`Enumeration` .
virtual IEnumEntry __clrcall	GetEntryByName (::System::String ^ name) Gets an enumeration entry node by name.
::System::String __clrcall	ToString (void) override Called by the `Node.ToString` method to return a`System.System::String` representation of this`Enumeration` __
Enumeration	operator= (::System::String ^ value) Assigns a value to this`Enumeration.Value` .
Enumeration	operator= (__int64 value) Assigns a value to this`Enumeration.Value` .
void __clrcall	set (EnumValue value)
virtual __clrcall	~Enumeration (void) Destroys this `Enumeration` and frees managed and unmanaged resources if needed.

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

See SpinnakerNET::GenApi::Node

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.

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

See SpinnakerNET::GenApi::IEnum

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 Static Functions¶

Type	Name
static	operator __int64 (Enumeration ^ obj) Converts this `Enumeration` implicitly into an`System.Int64` .
static	String ^ (Enumeration ^ obj) Converts this `Enumeration` implicitly into an`System.System::String` object.

Protected Attributes inherited from SpinnakerNET::GenApi::Node¶

See SpinnakerNET::GenApi::Node

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 inherited from SpinnakerNET::GenApi::Node¶

See SpinnakerNET::GenApi::Node

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 Entries¶

Gets all supported enum entries.

virtual property array<EnumEntry^> SpinnakerNET::GenApi::Enumeration::Entries;

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

variable Symbolics¶

Gets all available enum entry names.

virtual property array<::System::String^> SpinnakerNET::GenApi::Enumeration::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.

virtual property EnumValue SpinnakerNET::GenApi::Enumeration::Value;

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

Public Functions Documentation¶

function Enumeration [1/2]¶

Initializes all member fields of this Enumeration __

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

Parameters:

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

function Enumeration [2/2]¶

Creates an Enumeration from aNode object when possible.

__clrcall SpinnakerNET::GenApi::Enumeration::Enumeration (
    SpinnakerNET::GenApi::INode ^ obj
)

Parameters:

obj Object to create EnumertionNode from.

function FromString¶

Called by the Node.FromString method to parse the given__value . If the parsing succeeds the value is written to thisEnumeration .

virtual void  __clrcall SpinnakerNET::GenApi::Enumeration::FromString (
    ::System::String ^ value
)

Parameters:

value Text to be parsed.

function GetEntryByName¶

Gets an enumeration entry node by name.

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

Parameters:

name Name of the enumeration entry node.

Implements SpinnakerNET::GenApi::IEnum::GetEntryByName

function ToString¶

Called by the Node.ToString method to return aSystem.System::String representation of thisEnumeration __

::System::String __clrcall SpinnakerNET::GenApi::Enumeration::ToString (
    void
) override

Returns:

System.System::String containing the value of this node.

function operator=¶

Assigns a value to thisEnumeration.Value .

inline Enumeration SpinnakerNET::GenApi::Enumeration::operator= (
    ::System::String ^ value
)

function operator=¶

Assigns a value to thisEnumeration.Value .

inline Enumeration SpinnakerNET::GenApi::Enumeration::operator= (
    __int64 value
)

function set¶

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

Implements SpinnakerNET::GenApi::IEnum::set

function ~Enumeration¶

Destroys this Enumeration and frees managed and unmanaged resources if needed.

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

Public Static Functions Documentation¶

function operator __int64¶

Converts this Enumeration implicitly into anSystem.Int64 .

static inline static SpinnakerNET::GenApi::Enumeration::operator __int64 (
    Enumeration ^ obj
)

Parameters:

obj Object from which the Value is returned.

Returns:

System.Int64 containing the Value.

function String ^¶

Converts this Enumeration implicitly into anSystem.System::String object.

static inline static SpinnakerNET::GenApi::Enumeration::String ^ (
    Enumeration ^ obj
)

Parameters:

obj Object from which the Value is returned.

Returns:

System.System::String containing the Value.

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