ic.doc.extension
Interface Animator

public interface Animator

Method Summary

int	actionChosen() return the action number in AllNames of the last action chosen and executed
java.lang.String	actionNameChosen() return the action name of the last action chosen and executed
java.lang.String[]	getAllNames()
java.lang.String[]	getMenuNames()
boolean	getPriority() returns true if priority actions are low priority flase if they are low priority
java.util.BitSet	getPriorityActions() returns the bitset of menu actions with higher/lower priority
boolean	hasErrorTrace()
java.util.BitSet	initialise(java.util.Vector menu) initialises the Animator with the list of actions that are to be controlled menu is a vector of strings returns bitset of eligible menu actions
boolean	isEnd() return true if END state has been reached
boolean	isError() return true if error state has been reached
java.util.BitSet	menuStep(int choice) causes the Animator to take a single step by choosing one of the eligible menu actions returns a bitset of eligible menu actions
void	message(java.lang.String msg)
boolean	nonMenuChoice() returns true if there is an eligible action that is not a menu action
java.util.BitSet	singleStep() causes the Animator to take a single step by choosing one of the eligible non-menu actions
boolean	traceChoice()
java.util.BitSet	traceStep()

Method Detail

initialise

public java.util.BitSet initialise(java.util.Vector menu)

initialises the Animator with the list of actions that are to be controlled menu is a vector of strings returns bitset of eligible menu actions

getMenuNames

public java.lang.String[] getMenuNames()

getAllNames

public java.lang.String[] getAllNames()

menuStep

public java.util.BitSet menuStep(int choice)

causes the Animator to take a single step by choosing one of the eligible menu actions returns a bitset of eligible menu actions

singleStep

public java.util.BitSet singleStep()

causes the Animator to take a single step by choosing one of the eligible non-menu actions

actionChosen

public int actionChosen()

return the action number in AllNames of the last action chosen and executed

actionNameChosen

public java.lang.String actionNameChosen()

return the action name of the last action chosen and executed

isError

public boolean isError()

return true if error state has been reached

isEnd

public boolean isEnd()

return true if END state has been reached

nonMenuChoice

public boolean nonMenuChoice()

returns true if there is an eligible action that is not a menu action

getPriorityActions

public java.util.BitSet getPriorityActions()

returns the bitset of menu actions with higher/lower priority

getPriority

public boolean getPriority()

returns true if priority actions are low priority flase if they are low priority

message

public void message(java.lang.String msg)

hasErrorTrace

public boolean hasErrorTrace()

traceChoice

public boolean traceChoice()

traceStep

public java.util.BitSet traceStep()