org.openmi.standard
Interface IManageState


public interface IManageState

Manage State Interface. (To be implemented optionally, in addition to the linkable component interface.)


Method Summary
 void clearState(java.lang.String stateID)
          Clears a state from the linkable component's memory.
 java.lang.String keepCurrentState()
          Store the linkable component's current State.
 void restoreState(java.lang.String stateID)
          Restores the state identified by the parameter stateID.
 

Method Detail

keepCurrentState

java.lang.String keepCurrentState()
Store the linkable component's current State.

Returns:
State identifier.

restoreState

void restoreState(java.lang.String stateID)
Restores the state identified by the parameter stateID. If the state identifier identified by stateID is not known by the linkable component an exception should be trown.

Parameters:
stateID - State identifier.

clearState

void clearState(java.lang.String stateID)
Clears a state from the linkable component's memory. If the state identifier identified by stateID is not known by the linkable component an exception should be thrown.

Parameters:
stateID - State identifier.