IEnumeration Interface

Functions
virtual void	GetEntries (NodeList_t &Entries)=0
	Get list of entry nodes.
virtual IEnumeration &	operator= (const GenICam::gcstring &ValueStr)=0
	Set string node value.
virtual void	SetIntValue (int64_t Value, bool Verify=true)=0
	Set integer node value.
virtual GenICam::gcstring	operator* ()=0
	Get string node value.
virtual int64_t	GetIntValue (bool Verify=false, bool IgnoreCache=false)=0
	Get integer node value.
virtual IEnumEntry *	GetEntryByName (const GenICam::gcstring &Symbolic)=0
	Get an entry node by name.
virtual IEnumEntry *	GetEntry (const int64_t IntValue)=0
	Get an entry node by its IntValue.
virtual IEnumEntry *	GetCurrentEntry (bool Verify=false, bool IgnoreCache=false)=0
	Get the current entry.

Variables
interface SPINNAKER_API_ABSTRACT	IEnumeration
	Interface for enumeration properties.

Detailed Description

Function Documentation

GetCurrentEntry()

virtual IEnumEntry * GetCurrentEntry ( bool  Verify = false, bool  IgnoreCache = false  )

pure virtual

Get the current entry.

GetEntries()

virtual void GetEntries ( NodeList_t &  Entries )

pure virtual

Get list of entry nodes.

GetEntry()

virtual IEnumEntry * GetEntry ( const int64_t  IntValue )

pure virtual

Get an entry node by its IntValue.

GetEntryByName()

virtual IEnumEntry * GetEntryByName ( const GenICam::gcstring &  Symbolic )

pure virtual

Get an entry node by name.

GetIntValue()

virtual int64_t GetIntValue ( bool  Verify = false, bool  IgnoreCache = false  )

pure virtual

Get integer node value.

Parameters

Verify	Enables Range verification (default = false). The AccessMode is always checked
IgnoreCache	If true the value is read ignoring any caches (default = false)

Returns

The value read

operator*()

virtual GenICam::gcstring operator* ( )

pure virtual

Get string node value.

Get node value.

operator=()

virtual IEnumeration & operator= ( const GenICam::gcstring &  ValueStr )

pure virtual

Set string node value.

Set node value.

Note : the operator= is not inherited thus the operator= versions from IEnumeration must be implemented again

SetIntValue()

virtual void SetIntValue ( int64_t  Value, bool  Verify = true  )

pure virtual

Set integer node value.

Parameters

Value	The value to set
Verify	Enables AccessMode and Range verification (default = true)

Variable Documentation

IEnumeration

interface SPINNAKER_API_ABSTRACT IEnumeration

Interface for enumeration properties.