Initializing help system before first use

xpressinsight.AppInterface.set_scenario_test_data

Purpose
Sets the value that will be returned by requests for scenario data of the given class from the given scenario, in test mode.
Synopsis
xpressinsight.AppInterface.set_scenario_test_data(self, scenario_path_or_id: str, scenario_data_class: Type[~SCENARIO_DATA_CONTAINER], scenario_data: ~SCENARIO_DATA_CONTAINER)
Arguments
scenario_path_or_id 
The path or ID of the scenario from which you want to read.
scenario_data_class 
A class declared with the ScenarioData or AppConfig decorator.
scenario_data 
An instance of scenario_data_class that will be returned by future requests.
Example
Configure a value to be returned by future calls to get_scenario_data:
>>> @xi.ScenarioData
... class EntitiesToRead:
...     my_integer: xi.data.Scalar()
...     my_string: xi.data.Scalar()
...
... my_test_data = EntitiesToRead()
... my_test_data.my_integer = 123
... my_test_data.my_string = "hello"
... self.insight.set_scenario_test_data('/MyApp/MyFolder/MyScenario',
...                                     EntitiesToRead, my_test_data)			
Further information
The set_scenario_data method can only be called in test mode. Calling this method when insight.test_mode is False will cause the model to abort with a runtime error.
Related topics

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