Namespaces | |
maxon | |
Macros | |
#define | MAXON_CONFIGURATION_BOOL(CONFIGVALUE, DEFVALUE, DEVCATEGORY, HELPTEXT) |
#define | MAXON_CONFIGURATION_INT(CONFIGVALUE, DEFVALUE, MINVALUE, MAXVALUE, DEVCATEGORY, HELPTEXT) |
#define | MAXON_CONFIGURATION_FLOAT(CONFIGVALUE, DEFVALUE, MINVALUE, MAXVALUE, DEVCATEGORY, HELPTEXT) |
#define | MAXON_CONFIGURATION_STRING(CONFIGVALUE, DEFVALUE, DEVCATEGORY, HELPTEXT) |
#define | MAXON_CONFIGURATION_BOOL_SUBSCRIBER(CONFIGVALUE) |
#define | MAXON_CONFIGURATION_INT_SUBSCRIBER(CONFIGVALUE) |
#define | MAXON_CONFIGURATION_FLOAT_SUBSCRIBER(CONFIGVALUE) |
#define | MAXON_CONFIGURATION_STRING_SUBSCRIBER(CONFIGVALUE) |
Enumerations | |
enum class | CONFIGURATION_CATEGORY { REGULAR , DEVELOPMENT , MODULE , EXTENSION , IMPLEMENTATION , NONE , SUBSCRIBER } |
enum class | CONFIGURATIONENTRY_ORIGIN { APPLICATION , CONFIGURATION , ENVIRONMENT , COMMANDLINE } |
enum class | CONFIGURATIONENTRY_STATE { UNUSED , INVALIDARGUMENT , USED , OUTOFRANGE } |
Functions | |
enum maxon::CONFIGURATION_CATEGORY | MAXON_ENUM_LIST (CONFIGURATION_CATEGORY) |
enum maxon::CONFIGURATIONENTRY_ORIGIN | MAXON_ENUM_LIST (CONFIGURATIONENTRY_ORIGIN) |
enum maxon::CONFIGURATIONENTRY_STATE | MAXON_ENUM_LIST (CONFIGURATIONENTRY_STATE) |
MAXON_DATATYPE (ConfigInit, "net.maxon.datatype.configinit") | |
MAXON_DEPENDENCY (configuration) | |
Variables | |
REGULAR | |
DEVELOPMENT | |
MODULE | |
EXTENSION | |
IMPLEMENTATION | |
NONE | |
SUBSCRIBER | |
APPLICATION | |
CONFIGURATION | |
ENVIRONMENT | |
COMMANDLINE | |
UNUSED | |
INVALIDARGUMENT | |
USED | |
OUTOFRANGE | |
#define MAXON_CONFIGURATION_BOOL | ( | CONFIGVALUE, | |
DEFVALUE, | |||
DEVCATEGORY, | |||
HELPTEXT | |||
) |
Use these macros to define a so called 'Configuration Variable'. A global variable will be created under this name (CONFIGVALUE) that initially gets assigned the default (DEFVALUE). However a user or programmer can override this default in a config file (e.g. config.txt), the environment or a command line. A configuration file overrides the initial default, an environment variable the value of the configuration file and the command line the value of an environment variable. The name in the configuration file, environment and command line is identical to the one defined here (CONFIGVALUE), but can be used in a case-insensitive way.
Please note that these macros must only be used in global space, otherwise they will crash.
The HELPTEXT will show up when the application is started with the command line argument 'help'. DEVCATEGORY specifies in which category the variable falls.
#define MAXON_CONFIGURATION_INT | ( | CONFIGVALUE, | |
DEFVALUE, | |||
MINVALUE, | |||
MAXVALUE, | |||
DEVCATEGORY, | |||
HELPTEXT | |||
) |
Use these macros to define a so called 'Configuration Variable'. A global variable will be created under this name (CONFIGVALUE) that initially gets assigned the default (DEFVALUE). However a user or programmer can override this default in a config file (e.g. config.txt), the environment or a command line. A configuration file overrides the initial default, an environment variable the value of the configuration file and the command line the value of an environment variable. The name in the configuration file, environment and command line is identical to the one defined here (CONFIGVALUE), but can be used in a case-insensitive way.
Please note that these macros must only be used in global space, otherwise they will crash.
The HELPTEXT will show up when the application is started with the command line argument 'help'. DEVCATEGORY specifies in which category the variable falls.
#define MAXON_CONFIGURATION_FLOAT | ( | CONFIGVALUE, | |
DEFVALUE, | |||
MINVALUE, | |||
MAXVALUE, | |||
DEVCATEGORY, | |||
HELPTEXT | |||
) |
Use these macros to define a so called 'Configuration Variable'. A global variable will be created under this name (CONFIGVALUE) that initially gets assigned the default (DEFVALUE). However a user or programmer can override this default in a config file (e.g. config.txt), the environment or a command line. A configuration file overrides the initial default, an environment variable the value of the configuration file and the command line the value of an environment variable. The name in the configuration file, environment and command line is identical to the one defined here (CONFIGVALUE), but can be used in a case-insensitive way.
Please note that these macros must only be used in global space, otherwise they will crash.
The HELPTEXT will show up when the application is started with the command line argument 'help'. DEVCATEGORY specifies in which category the variable falls.
#define MAXON_CONFIGURATION_STRING | ( | CONFIGVALUE, | |
DEFVALUE, | |||
DEVCATEGORY, | |||
HELPTEXT | |||
) |
Use these macros to define a so called 'Configuration Variable'. A global variable will be created under this name (CONFIGVALUE) that initially gets assigned the default (DEFVALUE). However a user or programmer can override this default in a config file (e.g. config.txt), the environment or a command line. A configuration file overrides the initial default, an environment variable the value of the configuration file and the command line the value of an environment variable. The name in the configuration file, environment and command line is identical to the one defined here (CONFIGVALUE), but can be used in a case-insensitive way.
Please note that these macros must only be used in global space, otherwise they will crash.
The HELPTEXT will show up when the application is started with the command line argument 'help'. DEVCATEGORY specifies in which category the variable falls.
#define MAXON_CONFIGURATION_BOOL_SUBSCRIBER | ( | CONFIGVALUE | ) |
#define MAXON_CONFIGURATION_INT_SUBSCRIBER | ( | CONFIGVALUE | ) |
#define MAXON_CONFIGURATION_FLOAT_SUBSCRIBER | ( | CONFIGVALUE | ) |
#define MAXON_CONFIGURATION_STRING_SUBSCRIBER | ( | CONFIGVALUE | ) |
REGULAR |
Help will be shown when application is started with command line parameter help. Use this value for configuration variables that are relevant to an end-user.
DEVELOPMENT |
Help will be shown when application is started with command line parameter help=dev. Use this value for configuration variables that are relevant to a developer.
MODULE |
Help will be shown when application is started with command line parameter help=module. Don't use this for your own variables.
EXTENSION |
Help will be shown when application is started with command line parameter help=extension. Don't use this for your own variables.
IMPLEMENTATION |
Help will be shown when application is started with command line parameter help=impl. Don't use this for your own variables.
NONE |
No help will be shown.
SUBSCRIBER |
This entry jjust copies whatever setting has been assigned to the owner.
APPLICATION |
Configuration value was defined by the application itself.
CONFIGURATION |
Configuration value originated from a configuration file.
ENVIRONMENT |
Configuration value originated from an environment variable.
COMMANDLINE |
Configuration value originated from a command line parameter.
UNUSED |
Configuration value was not used by or known to the application. This is e.g. true for environment variables that the application cannot process.
INVALIDARGUMENT |
Configuration value was recognized by the application, but argument was invalid.
USED |
Configuration value was recognized and successfully used by the application.
OUTOFRANGE |
Configuration value was recognized by the application, but argument was out of range. The value has been clamped and is now valid.