elStressScenarioIds
Introduced in version: 21.8
Last modified in version : -
Purpose : retrieve the stress scenarios' ids and short descriptions.
Last modified in version : -
Purpose : retrieve the stress scenarios' ids and short descriptions.
Summary
This function exposes the list of stress scenarios’ ids and descriptions. You can then use the ids list in your elStressScenario or ewrStressScenario functions.
Examples
=elStressScenarioIds(,TRUE)
Exposes an output of 2 columns where you see the stress scenarios’ ids and descriptions. If nothing is specified in the function, it returns the list of ids only. In the first parameter, you can specify the type of stress scenarios you want the function to return.
Syntax
elStressScenarioIds(StressScenarioType, WithDescription)
| Argument name | Default | Description |
|---|---|---|
| StressScenarioType | all types of scenarios | historical, propagated, simple |
| WithDescription | FALSE | Boolean |