Parameter Name and Identifier
Each MultiCam parameter has a name, that is a string 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, a parameter name uses upper- and lower-case letters to improve the readability. Nevertheless, the MultiCam database is not case-sensitive.
Example: ChannelState
Parameters are to be invoked in the body of C functions used to interact with the MultiCam system. Two methods are provided to refer to a parameter:
- The by-name method
- The by-identifier method
The by-name method employs the above described syntax.
The by-identifier method uses an parameter 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 MultiCam releases.
The parameter identifier is built from the parameter name, according to the following rules:
- The parameter name is prefixed with "MC_"
- The plus sign is replaced by the lower-case letter "p"
- The minus sign is replaced by the lower-case letter "m"
Example: MC_ChannelState
The parameter identifier is an integer value unambiguously designating the parameter.
The parameter identifiers have the MultiCam-defined type MCPARAMID.