|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.ObjectPER.rover.ActionTemplate
Template for creating an Action. Replace all instances of "ActionTemplate" with the name of your Action. You will want to modify the ActionTemplate constructor and the doit, setTime, getSummary, and getShortSummary methods. If your Action takes pictures, you will also want to modify the getRecentImage and getImageUpdateTime methods.
Action,
Serialized Form| Constructor Summary | |
ActionTemplate()
Creates a new ActionTemplate. |
|
| Method Summary | |
boolean |
doAction(Rover r)
Tries to start the action. |
long |
getImageUpdateTime()
Lets you know when the last image was taken by this action. |
java.awt.image.BufferedImage |
getRecentImage()
Returns the most recent image taken by this Action. |
int |
getReturnValue()
The return value of the Action. |
java.lang.String |
getShortSummary()
Provides a shortened version of the summary returned by getSummary. |
java.lang.String |
getSummary()
Provides a textual explanation of the Action, such as "turn 90 degrees" |
int |
getTime()
How long the action will take, in milliseconds. |
int |
getTimeRemaining()
How much time until the action finishes (in milliseconds), if it has already started. |
boolean |
isCompleted()
Whether the action has completed. |
boolean |
isSuccess()
Whether the action completed successfully. |
void |
kill()
Emergency stop - end the action immediately, if it's running. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public ActionTemplate()
| Method Detail |
public boolean doAction(Rover r)
Action
doAction in interface Actionpublic int getTime()
Action
getTime in interface Actionpublic java.lang.String getSummary()
Action
getSummary in interface Actionpublic java.lang.String getShortSummary()
Action
getShortSummary in interface Actionpublic int getReturnValue()
Action
getReturnValue in interface ActionRoverState,
ActionConstantspublic boolean isSuccess()
Action
isSuccess in interface Actionpublic boolean isCompleted()
Action
isCompleted in interface Actionpublic void kill()
Action
kill in interface Actionpublic int getTimeRemaining()
Action
getTimeRemaining in interface Actionpublic java.awt.image.BufferedImage getRecentImage()
Action
getRecentImage in interface Actionpublic long getImageUpdateTime()
Action
getImageUpdateTime in interface Action
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||