|
Action:
|
Sets a check point for roll back and returns model differences since previous call to
api_note_state.
|
|
|
Prototype:
|
outcome api_note_state (
|
|
|
DELTA_STATE*& ds,
|
// state change returned
|
|
|
HISTORY_STREAM* hs
|
// history stream
|
|
|
|
= NULL,
|
// to check
|
|
|
logical delete_if_empty
|
// flag to delete
|
|
|
|
= FALSE
|
// if empty
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "kernel/kernapi/api/kernapi.hxx"
|
|
#include "kernel/kerndata/bulletin/bulletin.hxx"
|
|
#include "baseutil/logical.h"
|
|
|
Description:
|
This API notes the current state of the model and returns a pointer to a
delta_state that contains differential model data covering the period since the previous call to
api_note_state.
|
|
|
If there have been no model changes since the last call to
api_note_state the returned
DELTA_STATE* will be
NULL.
|
|
|
The default
HISTORY_STREAM is used, unless a different history stream is supplied.
|
|
|
If the logical
delete_if_empty is
TRUE, an empty
DELTA_STATE (i.e. one with no bulletins) will be removed from the stream when noted.
|
|
|
To return the model to the previous state from the current state, call
api_change_state with the
delta_state as argument.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Read-only
|