stella.error
Class AdapterFwhm

java.lang.Object
  java.util.EventObject
      util.rmi.RmiEvent
          stella.MessageEvent
              stella.ErrorEvent
                  stella.error.AdapterFwhm

All Implemented Interfaces:

Serializable, ParameterConnected

public class AdapterFwhm
extends ErrorEvent
implements ParameterConnected

A status mesage from the adapter delivering the FWHM of a star image on the guiding camera. It is a status message, therefore it has no follow up. To allow parameter updates, it is piping. The ascii format of the status carries the fwhm and the total flux in a single line:

   FWHM=[fwhm, pixel] FLUX=[total flux, e-]
   

Note that the units (pixel, e^-) might be adapted to further needs. Ultimately, the flux should be given in instrumental magnitudes and the fwhm in arcseconds.

See Also:

Serialized Form

Field Summary

private double	flux The value of the flux.
private static String	FOLLOWUP The follow-up (none).
private double	fwhm The value of the FWHM.
private static boolean	PIPING The pipe flag (true).
private static int	SEVERENESS The severness level (interesting importance).
private static String[]	VARS The names of the variables in the command line, index 1.

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

AdapterFwhm(Object src)
Constructs a new adapter fwhm status message.

Method Summary

double	getFlux() Returns the value of the flux.
double	getFWHM() Returns the value of the fwhm.
String	getHuman() Returns the human-readable part of the string.
String[]	getLine() Returns the command lines as an string array.
boolean	parseLine(String[] all) Parses the command lines submitted with the adapter fwhm status.
void	setFWHMAndFlux(double newfwhm, double newflux) Sets the fwhm and the flux.
private void	updateHuman() Updates the human readable part of the status message.

Methods inherited from class stella.ErrorEvent

consume, createError, createError, createError, createError, createError, createStatus, createStatus, createStatus, extractClassName, extractFollowUp, extractPipe, getErrorClass, getFollowUp, 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 (interesting importance).

See Also:

Constant Field Values

FOLLOWUP

private static final String FOLLOWUP

The follow-up (none). Ignored anyhow.

See Also:

Constant Field Values

PIPING

private static final boolean PIPING

The pipe flag (true).

See Also:

Constant Field Values

VARS

private static final String[] VARS

The names of the variables in the command line, index 1.

fwhm

private double fwhm

The value of the FWHM.

flux

private double flux

The value of the flux.

Constructor Detail

AdapterFwhm

public AdapterFwhm(Object src)

Constructs a new adapter fwhm status message. The FWHM must be set after construction by a call to setFWHMAndFlux(double, double).

Method Detail

parseLine

public boolean parseLine(String[] all)

Parses the command lines submitted with the adapter fwhm status. Extracts the fwhm and the flux using the StringTool.parseNumbers(java.lang.String, java.lang.String[]) method.

Overrides:

parseLine in class ErrorEvent

Returns:

True, if parsing was successful.

getLine

public String[] getLine()

Returns the command lines as an string array. See also main class entry.

Overrides:

getLine in class ErrorEvent

Returns:

An array containing all command lines.

getHuman

public String getHuman()

Returns the human-readable part of the string. See also main class entry.

Overrides:

getHuman in class ErrorEvent

Returns:

A String holding a readable description of the error.

updateHuman

private void updateHuman()

Updates the human readable part of the status message. This means calling of ErrorEvent.setHuman(java.lang.String) with values constructed from the internal variables.

getFWHM

public double getFWHM()

Returns the value of the fwhm.

getFlux

public double getFlux()

Returns the value of the flux.

setFWHMAndFlux

public void setFWHMAndFlux(double newfwhm,
                           double newflux)

Sets the fwhm and the flux. After a call to this method, the status event is set valid. See main entry for units.

Parameters:

newfwhm - The FWHM this status event should carry.

newflux - The flux this status event should carry.