GenApi_EnumDescriptor

This structure stores the description of a GenApi Enumeration parameter node.

struct GenApi_EnumDescriptor
{
	ftl::Array< GenApi_EnumEntryDescriptor > Entries;
};

• Entries - List of enumeration entries, see below.

struct GenApi_EnumEntryDescriptor
{
	ftl::String Id;
	ftl::String DisplayName;
	ftl::String Description;
	bool IsImplemented;
	bool IsAvailable;
	double NumericValue;
};

• Id - internal identification name. This name must be used when accessing Enumeration parameter value.
• DisplayName - entry's friendly name (human readable).
• Description - entry's textual description provided by device manufacturer.
• IsImplemented - flag indicating if this entry is implemented in the currently opened device/module.
• IsAvailable - flag indicating if this parameter is implemented and available in the current device state.
• NumericValue - when enumeration parameter is associated with a numeric value this field returns such value. For example, enumeration on top of numeric parameter may contain entries: Low, Medium and High that translates into actual values. Most of enumerations however are not associated with numeric values and usually this field contains an unrelated random value.