Parameters

Parameters are scalar values that can be used to configure an Insight scenario. When parameters are declared, their name, data type, and default value must be specified. The data type can be omitted if the default value is specified and vice versa. Parameter values are automatically passed from the scenario to Insight app such that their value from the scenario is available in all execution modes. In particular, the parameter values are available in the standard load mode. Within the Insight execution mode, parameters should be treated as runtime constants. They can only be changed in the Insight user interface and any changes in an execution mode will not be transferred back to the Insight server, i.e., the scenario parameters remain unchanged. Some examples include:

import xpressinsight as xi

@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.
    # Parameter "P" of type "xi.integer" with default value 100.
    P: xi.Param(100)
    # Parameter "DEBUG" of type "xi.boolean" with default value False.
    DEBUG: xi.Param(False)
    # Parameter "PI" of type "xi.real" with default value 3.14.
    PI: xi.Param(3.14)
    # Parameter "STR_PARAM" of type xi.string with default value 'My String Param'.
    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 "".

    # TODO: Define execution modes here.

Parameters are typically read-only.