Group IEnumeration_h

Modules > IEnumeration_h

Public Attributes

Type	Name
interface SPINNAKER_API_ABSTRACT	IEnumeration Interface for enumeration properties.

Public Functions

Type	Name
virtual IEnumEntry *	GetCurrentEntry (bool Verify=false, bool IgnoreCache=false) = 0
virtual void	GetEntries (NodeList_t & Entries) = 0
virtual IEnumEntry *	GetEntry (const int64_t IntValue) = 0
virtual IEnumEntry *	GetEntryByName (const GenICam::gcstring & Symbolic) = 0
virtual int64_t	GetIntValue (bool Verify=false, bool IgnoreCache=false) = 0
virtual void	SetIntValue (int64_t Value, bool Verify=true) = 0
virtual GenICam::gcstring	operator* () = 0
virtual IEnumeration &	operator= (const GenICam::gcstring & ValueStr) = 0

Public Attributes Documentation

variable IEnumeration

Interface for enumeration properties.

interface SPINNAKER_API_ABSTRACT Spinnaker::GenApi::IEnumeration;

---

Public Functions Documentation

function GetCurrentEntry

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

Get the current entry

---

function GetEntries

virtual void GetEntries (
    NodeList_t & Entries
) = 0

Get list of entry nodes

---

function GetEntry

virtual IEnumEntry * GetEntry (
    const int64_t IntValue
) = 0

Get an entry node by its IntValue

---

function GetEntryByName

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

Get an entry node by name

---

function GetIntValue

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

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

---

function SetIntValue

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

Set integer node value

Parameters:

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

---

function operator*

virtual GenICam::gcstring operator* () = 0

Get string node value

Get node value

---

function operator=

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

Set string node value

Set node value

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

Set node value

---

---