API Methods for Stepping Through Plots
The Boolean methods below are available for stepping through plots with multiple solutions. They return true if the parameter value was changed; otherwise, they return false. The methods are applicable to plot groups and plots.
Table 7-6: API Methods for Stepping Through Plots.
Method
Description
boolean stepPrevious(int level)
Corresponds to Plot Previous.
boolean stepNext(int level)
Corresponds to Plot Next.
boolean stepFirst(int level)
Corresponds to Plot First.
boolean stepLast(int level)
Corresponds to Plot Last.
The input argument level is an integer that indicates the level in a model with several levels of parameters or other types of multiple solutions (such as a parametric sweep around a time-dependent simulation).
When using these methods in an app, it can also be useful to be able to test if these operations are applicable. For example, it is not possible to step to the previous parameter value if the current parameter value is the first parameter value. It can also be useful to be able to test if it is possible to step for a given level (as the level might be larger than the number of available parameters) and to test if it is possible to step at all. To test for such case, use the following API methods:
Table 7-7: API Methods for Checking if Stepping is Possible.
Method
boolean canStepPrevious(int level)
boolean canStepNext(int level)
boolean canStepFirst(int level)
boolean canStepLast(int level)
Being able to retrieve the number of levels that can be stepped over can be useful when the API methods described above are used. To do so, use the following method:
int getStepLevels()