AppInterface.scenario_name

Purpose

Property for the name of the Xpress Insight scenario.

Synopsis

scenario_name: str

Return value

The name of the Xpress Insight scenario.

Example

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

>>> insight.scenario_name = 'Scenario B'

Demonstration of getting the scenario name.

>>> print('scenario name = ', insight.scenario_name)
scenario name = Scenario B

Further information

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

2. In test mode can be used to mock the Insight scenario name. By default, insight.scenario_name 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.