|
Action:
|
Modifies modeler state by applying zero or more delta_states.
|
|
|
Prototype:
|
outcome api_roll_n_states (
|
|
|
HISTORY_STREAM* hs,
|
// history stream to roll
|
|
|
int nRequest,
|
// number of states to
|
|
|
|
|
// roll; positive is
|
|
|
|
|
// forward, negative is
|
|
|
|
|
// backward.
|
|
|
int& nActual
|
// returns number of
|
|
|
|
|
// delta states rolled
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "kernel/kernapi/api/kernapi.hxx"
|
|
#include "kernel/kerndata/bulletin/bulletin.hxx"
|
|
|
Description:
|
This API modifies the modeler's state by rolling forward or back the given number of times. When rolling forward past a branch in the history stream the branch taken is unspecified. To take a particular, save a pointer to a state on the branch and use
api_change_to_state. Branches are created by rolling back and then making additional changes to the model.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Changes model
|