getparam
Purpose
Synopsis
function getparam(name:string):integer|string|real|boolean
Argument
|
name
|
Name of the control parameter whose value is to be returned (case insensitive).
|
Return value
Current setting of the control parameter.
Example
Setting and retrieving values of control parameters
r:=0,123
setparam("realfmt", "%.5f")
writeln("r=", r) ! Output: r=0,123
writeln("Model ", getparam("modelname"), " version:", getparam("model_version"))
Further information
1. Parameters whose values may be returned by this function include the settings of Mosel as well as those of any loaded module or package. The location of the parameter may be specified by prefixing its name with the name of the module or package defining it (
e.g.
mmxprs.XPRS_verbose). The type of the return value corresponds to the type of the parameter.
2. This function can be applied only to control parameters whose value can be accessed.
3. The
name argument must be a constant string: a model parameter, variable or string expression cannot be used as a control parameter name.
4. The following control parameters are supported by Mosel (see detailed documentation in Chapter
Control parameters):
| autofinal | whether initialisation from blocks are finalizing sets |
| bimprefix | list of bim file prefixes |
| ioctrl | whether the interpreter ignores I/O errors |
| iostatus | status of the last I/O operation |
| lang | current language |
| localedir | directory where message catalogs are stored |
| mathctrl | whether the interpreter ignores maths errors |
| modelname | internal unique name of the model being executed |
| modelnumber | order number of the model being executed |
| nbread | number of items recognized by the last read or 'initializations from' |
| readcnt | generate per label counting when executing `initializations from' blocks |
| realfmt | default C printing format for real numbers |
| restrict | active restrictions |
| recloc | activate automatic recording of source location of constraint definitions |
| runparams | parameter string used for the current execution |
| sharingstatus | sharing status of the model |
| tmpdir | the Mosel temporary directory |
| txtztol | zero tolerance for converting real values to their textual representation |
| utc | whether the time functions return time expressed in local or UTC time |
| workdir | the current working directory of the model |
| zerotol | zero tolerance in comparisons between reals |
5. Function
getparam may also be used to retrieve
parser parameters
. As opposed to the other parameters whose value is computed at run time, these parameters are evaluated as soon as they are parsed:
| model_version | version of the model as given by the version directive |
| parser_date | current local date |
| parser_file | current source file name |
| parser_line | number of the line being parsed |
| parser_time | current local time |
| parser_UTCdate | current UTC date |
| parser_UTCtime | current UTC time |
| parser_version | Mosel version |
Related topics
© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation ("FICO"). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.