Try our new documentation site (beta).
ScenarioNumber
Selects scenario index of multi-scenario models
Type: | int | |
---|---|---|
Default value: | 0 | |
Minimum value: | 0 | |
Maximum value: | MAXINT |
When working with multiple scenarios, this parameter selects the
index of the scenario you want to work with. When you query or modify an
attribute associated with multiple scenarios
(ScenNLB, ScenNUB,
ScenNObj, ScenNRHS,
etc.), the ScenarioNumber
parameter will determine which scenario
is actually affected. The value of this parameter should be less than
the value of the NumScenarios attribute (which
captures the number of scenarios in the model).
Please refer to the discussion of Multiple Scenarios for more information on the use of alternative scenarios.
One important note about integer-valued parameters: while the maximum value that can be stored in a signed integer is , we use a MAXINT value of 2,000,000,000. Attempting to set an integer parameter to a value larger than this maximum will produce an error.
For examples of how to query or modify parameter values from our different APIs, refer to our Parameter Examples.