|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.ObjectPER.rover.SendEmailAction
Allows the rover to send email messages.
| Constructor Summary | |
SendEmailAction()
Creates a new instance of SendEmailAction with an empty message and the subject "Message from Rover!". |
|
SendEmailAction(java.lang.String recip,
java.lang.String msg)
Creates a new instance of SendEmailAction with the subject "Message from Rover!". |
|
SendEmailAction(java.lang.String recip,
java.lang.String msg,
java.lang.String subj)
Creates a new instance of SendEmailAction. |
|
| 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. |
void |
setFrom(java.lang.String roverName)
Sets the name of the email sender. |
void |
setMessage(java.lang.String msg)
Sets the email's message to msg . |
void |
setRecipient(java.lang.String recip)
Sets the message recipient to recip . |
void |
setServer(java.lang.String SMTP)
Sets the SMTP server to be used when sending the email message. |
void |
setSubject(java.lang.String subj)
Sets the email's subject to subj . |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public SendEmailAction()
setRecipient(java.lang.String)
public SendEmailAction(java.lang.String recip,
java.lang.String msg)
public SendEmailAction(java.lang.String recip,
java.lang.String msg,
java.lang.String subj)
| Method Detail |
public void setRecipient(java.lang.String recip)
recip .
public void setMessage(java.lang.String msg)
msg .
public void setSubject(java.lang.String subj)
subj .
public void setServer(java.lang.String SMTP)
public void setFrom(java.lang.String roverName)
public boolean doAction(Rover r)
Action
doAction in interface Actionpublic int getReturnValue()
Action
getReturnValue in interface ActionRoverState,
ActionConstantspublic java.lang.String getShortSummary()
Action
getShortSummary in interface Actionpublic java.lang.String getSummary()
Action
getSummary in interface Actionpublic int getTime()
getTime in interface Actionpublic boolean isSuccess()
Action
isSuccess in interface Actionpublic boolean isCompleted()
Action
isCompleted in interface Actionpublic void kill()
kill in interface Actionpublic int getTimeRemaining()
getTimeRemaining in interface Actionpublic long getImageUpdateTime()
Action
getImageUpdateTime in interface Actionpublic java.awt.image.BufferedImage getRecentImage()
Action
getRecentImage in interface Action
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||