cConfigurationEx Class Reference¶

Flags for the 'flags' argument of the getKeyValuePairs() method.

Initializes configuration object from "boot-time" configuration (omnetpp.ini). For example, if a particular cConfiguration subclass uses a database as data source, it may take the connection parameters from the "boot-time" configuration. This method makes global config immediately available, i.e. there is no need for an additional activateConfig() call.

Returns the name of the configuration file. Returns nullptr if this object is not using a configuration file.

Validates the configuration: reports obsolete config keys, cycles in the section fallback chain, unrecognized keys, etc as exceptions.

ignorableConfigKeys is the list of config keys whose presence in the configuration should not be reported as errors even if they are not declared using cConfigOptions. The list is space-separated, and items may contain wildcards. Typically, this list will contain "cmdenv-*" when Cmdenv is unavailable (not linked in), "qtenv-*" when Qtenv is unavailable, etc, so that validate() does not report those keys in omnetpp.ini as errors.

Returns the names of the available configurations.

Activates the [Config <name>] section. If it does not exist, an error is thrown. [General] is treated as short for [Config General]. The runNumber must be between 0 and getNumRunsInConfig(name)-1.

Returns the description of the given configuration.

Returns true if the given configuration is abstract, i.e. it only serves as a base for other configuration.

Returns the names of the configurations the given configuration extends directly. Only names of existing configurations are returned (that is, if "extends" is bogus and refers to a nonexistent configuration, this method omits that configuration name; also, "General" is only returned if such configuration actually exists.)

Returns the names of the configurations the given configuration extends transitively. This is the search order of parameter lookups from the given configuration. Only names of existing configurations are returned.

Generates Cartesian product of all iterations within the given config, and counts them. If the config does not exist, an error is thrown. [General] is treated as short for [Config General].

Generates all runs in the given configuration, and returns a string for each. When detailed==false, each run will generate a one-line string with the iteration variables; with detailed==true, each run generates a multi-line string containing the config entries that contain iterations or iteration variable references. This method is primarily for debugging purposes.

TODO update description

Returns the name of the currently active configuration.

Returns currently active run number. This is the number passed to activateConfig(), or 0 if activateConfig() has not been called.

After activating a configuration, this method can be used to query iteration variables and predefined variables. These are the variables that can be referred to using the "${...}" syntax in the configuration. If the variable does not exist, nullptr is returned.

Some of the predefined variables are: "configname", "runnumber", "network", "processid", "datetime", "runid", "repetition", "iterationvars"; these names are also available as symbolic constants, see CFGVAR_CONFIGNAME and other CFGVAR_xxx names.

Returns the names of all iteration variables in the activated configuration.

Returns the names of all predefined variables in the activated configuration. See getVariable().

Returns the description of the given variable in the activated configuration. Returns nullptr if the variable does not exist or no description is available.

For debugging.

Returns the list of config keys that match the given wildcard pattern. The returned keys can be passed to getConfigValue().

Looks up the value of the given parameter in the inifile. The argument hasDefaultValue controls whether "=default" entries need to be considered. Return value is nullptr if the parameter is not specified in the inifile, otherwise returns the string after the equal sign.

Like getParameterValue(), but this one returns information about the whole inifile entry, not just the value string. If the key is not found, a special KeyValue object is returned where both key and value are nullptr.

Lifetime of the returned object might be limited, so clients should not store references to it. Copying the object is not allowed either, because KeyValue is a polymorphic type (object slicing!).

This method returns an array of the following form: (key1, value1, key2, value2,...), where keys and values correspond to (a subset of) the entries in the active configuration.

The 'flags' parameter should take its value from the FilterFlags enum, or the binary OR of several such flags: FILT_PARAM, FILT_CONFIG, etc.

Returns the list of suffixes from keys that match the wildcard pattern objectFullPath + dot + keySuffixPattern. objectFullPath may either be a concrete string without wildcards, or "**" to match anything. The returned keys may be used with getPerObjectConfigValue() to obtain the corresponding values. The returned suffixes may be used with getPerObjectConfigValue() to obtain the corresponding values.