Initializing help system before first use

Param

Param


Purpose
Represents a parameter entity. Parameters can be used to configure an Xpress Insight app. When parameters are declared, their name, data type, and default value must be specified. Parameters are typically read-only.
Example
Some examples of declaring parameter entities in the data model.
>>> @xi.AppConfig(name="My First Insight Python App",
...               version=xi.AppVersion(0, 1, 2))
... class MyApp(xi.AppBase):
...
...     # examples where data type is inferred from the default value
...     # Param "P" of type "xi.integer" with default value 100
...     P: xi.Param(100)
...     # Param "DEBUG" of type "xi.boolean" with default value False
...     DEBUG: xi.Param(False)
...     # Param "PI" of type "xi.real" with default value 3.14
...     PI: xi.Param(3.14)
...     # Param "STR_PARAM" of type xi.string with a default value
...     STR_PARAM: xi.Param('My String Param')
...
...     # examples where data type is explicitly given
...     BOOL_PARAM: xi.Param(dtype=xi.boolean)  # default value False
...     INT_PARAM: xi.Param(dtype=xi.integer)  # default value 0
...     REAL_PARAM: xi.Param(dtype=xi.real)  # default value 0.0
...     STRING_PARAM: xi.Param(dtype=xi.string)  # default value ""		
Related topics

© 2001-2020 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.