Click or drag to resize

Enum Editor

Name

Name of the enum. Enum names must start with a capital letter and can contain only alphanumeric characters.

It is important to note that enumerated types are not supported in IVI-C drivers, so defining an IVI-C enum in Nimbus does not actually produce a enum definition anywhere in the driver API. This name serves to associated a set of related defined values (the enum members). For message-based drivers that use automatic command formatting, this name is also used to create special command converter classes that translate instrument commands and responses to and from their corresponding enum member values, as assigned in the Enum Member Editor.

These enum converter classes are defined in the enum macro map maintained in the driver project's Enums.h file. All of the converter classes derive from the EnumConverter base class and expose functions for converting instrument commands and responses to and from enum member values. See the discussion of the EnumConverter in the Nimbus Runtime Library for details.

See Also

Download a complete CHM version of this documentation here.