stella.error
Class TracktimeRemaining

java.lang.Object
  extended by java.util.EventObject
      extended by util.rmi.RmiEvent
          extended by stella.MessageEvent
              extended by stella.ErrorEvent
                  extended by stella.error.TracktimeRemaining
All Implemented Interfaces:
Serializable, ParameterConnected

public class TracktimeRemaining
extends ErrorEvent
implements ParameterConnected

A status event that is sent after a MoveTelescope command. It carries the maximum remaining tracking time until the telescope reaches any limit switches or traverses the zenith. It has a raised pipe flag to allow feeding of a proper parameter.

This status message is allways generated within the telescope. The human readable part is a single line giving the number of seconds remaining. In the java world this status will always be generated with the ErrorEvent.createError(stella.MessageBin) method.

See Also:
Serialized Form

Field Summary
private static String FOLLOWUP
          The follow-up (shutdown).
private static boolean PIPING
          The pipe flag (false).
private  long remain
          The remaining track-time carried by this status, in ms.
private static int SEVERENESS
          The severness level (status message).
 
Fields inherited from class stella.ErrorEvent
ABORT_EXPOSURE, ABORT_TARGET, ALARM_OFF, ALARM_ON, BAD_SEEING, BAD_WEATHER, CLEAR_TEL, CLOSE_COVER, CLOSE_ROOF, CLOSE_SHUTTER, CONT_TIME, ERROR_TOKEN, ERRORCOMBINE, ERRORPACKAGE, GOOD_WEATHER, HIGH_WIND, MAIL_HOME, MAIL_LOCAL, MOVE_HOME, MOVE_PARK, NONE, OPEN_COVER, OPEN_SHUTTER, PIPE, REACQUIRE, REPOSITION, RESEND_COMMAND, RESET_ADAPTER, RESET_CALIBRATION, RESET_CCD, RESET_ENV, RESET_ERRORS, RESET_SPEC, RESET_TEL, SHUT_DOWN, STATUS_TOKEN, STOP_TIME
 
Fields inherited from class stella.MessageEvent
SEPCHAR
 
Fields inherited from class util.rmi.RmiEvent
localHost, sourceName
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
TracktimeRemaining(Object src)
          Constructs a track time remaining status.
 
Method Summary
 long getTrackTimeRemaining()
          Returns the tracking time as carried by the status in ms.
 boolean parseLine(String[] all)
          Parses the command lines submitted with this status event.
 void setTrackTimeRemaining(long time)
          Sets the track time remaining.
 
Methods inherited from class stella.ErrorEvent
consume, createError, createError, createError, createError, createError, createStatus, createStatus, createStatus, extractClassName, extractFollowUp, extractPipe, getErrorClass, getFollowUp, getHuman, getLine, getSevereness, isConsumed, isPipe, isStatus, parseClassName, parseHeader, setFollowUp, setHuman, setHuman, setPipe
 
Methods inherited from class stella.MessageEvent
checkType, equals, equalTime, equalTime, fromAscii, getAllCommandLines, getExecuteGroupKey, getHead, getNr, getTime, getType, hashCode, isValid, parseFromSingleString, readFromBufferedStream, setNr, setTime, setType, setValid, toString
 
Methods inherited from class util.rmi.RmiEvent
getHost, getSourceName, setSourceName
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SEVERENESS

private static final int SEVERENESS
The severness level (status message).

See Also:
Constant Field Values

FOLLOWUP

private static final String FOLLOWUP
The follow-up (shutdown).

See Also:
Constant Field Values

PIPING

private static final boolean PIPING
The pipe flag (false).

See Also:
Constant Field Values

remain

private long remain
The remaining track-time carried by this status, in ms.

Constructor Detail

TracktimeRemaining

public TracktimeRemaining(Object src)
Constructs a track time remaining status. Uses the SEVERENESS level, has a FOLLOWUP as a recovery strategy an does pipe.

Method Detail

parseLine

public boolean parseLine(String[] all)
Parses the command lines submitted with this status event. After doing the overall parsing with the parental method, the remaining track-time is extracted out of the first line of the human readable part. This line carries the track time in seconds, which is converted to a time in ms.

Overrides:
parseLine in class ErrorEvent
Returns:
True, if parsing was successful.

getTrackTimeRemaining

public long getTrackTimeRemaining()
Returns the tracking time as carried by the status in ms. A TrackTime paramter then grabs the value and counts down from it.


setTrackTimeRemaining

public void setTrackTimeRemaining(long time)
Sets the track time remaining.

Parameters:
time - The remaining track-time in ms.