AppInterface.scenario_id

Purpose

Property for the id of the Xpress Insight scenario.

Synopsis

scenario_id: str

Return value

The UID of the Xpress Insight scenario.

Example

Demonstration of setting the scenario id (test mode only).

>>> insight.scenario_id = 'xyzzy'

Demonstration of getting the scenario id.

>>> print('scenario id = ', insight.scenario_id)
scenario id = xyzzy

Further information

1. The scenario_id property can only be set in test mode.

2. In test mode can be used to mock the Insight scenario id. By default, insight.scenario_id will return an empty string in test mode.

3. Modifying this property when insight.test_mode is False will cause the model to abort with a runtime error.