Enumerated Name and Identifier
An enumerated parameter can assume a defined set of values. Each possible value is represented by a character string called an enumerated name.
The enumerated names are made of alphanumeric characters, without space, freely including letters, figures and a few special characters.
Allowed characters
Any letter |
A, B, C, D... |
Any figure |
0, 1, 2, 3... |
+ |
Plus sign |
- |
Minus sign |
_ |
Underscore |
Conventionally, an enumerated name exclusively uses upper-case letters.Nevertheless, the MultiCam database is not case sensitive.
Example: IDLE
Enumerated items are to be invoked in the body of C functions used to interact with the MultiCam system. Two methods are provided to refer to an enumerated item.
- The by-name method
- The by-identifier method
The by-name method employs the above described syntax.
The by-identifier method uses an enumerated identifier defined in the header file McParams.h. This file is included by the MultiCam.h header file. The header files are maintained by Euresys and are part of the official MultiCam releases.
The enumerated identifier is built from the enumerated name according to the following rules:
- The enumerated value is prefixed with "MC_OwningParameter_"
- The plus sign is replaced by the lower-case letter "p"
- The minus sign is replaced by the lower-case letter "m"
OwningParameter is the name of the relevant enumerated parameter.
Example: MC_ChannelState_IDLE
The enumerated identifier is an integer value unambiguously designating the enumerated item.
The enumerated identifiers have the regular type INT32.