stella.telescope

Class GregorDriver

java.lang.Object

util.PropertyContainer

io.AbstractDriver

io.AbstractSocketDriver

stella.net.gregor.CommunicationHandler

stella.net.gregor.GetterSetter

stella.telescope.GregorDriver

All Implemented Interfaces:

ParameterDepending, Driver, StreamIODriver, Cloneable, EventListener, MessageListener, DerotatorAccessible, FocusAccessible, OffsetAccessible, PointingAccessible, PointingProviding, TelescopeDriver, ExitCleaning, Initializable, PropertySupplying

public class GregorDriver
extends GetterSetter
implements TelescopeDriver, ParameterDepending, PointingProviding

Class that represents the gregor telescope within the SCS robotic framework. First version uses confirmation dialogs to ensure save operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	GregorDriver.KeyIn
static class	GregorDriver.Test Test class, pops up a frame and asks for init.

Field Summary

Fields

Modifier and Type	Field and Description
private Value	alttarget Value stating elevation of target.
private Value	aztarget Value stating azimuth of target.
private static boolean	DEFCONFIRMONTIMEOUT Default property value.
private static String	DEFDESTINATION Default property value.
private static long	DEFMOVETIME Time for moving the telescope, maximum.
private static long	DEFOFFSETTIME Time for offsetting the telescop, maximum.
private static boolean	DEFPRECESS Default property value.
private static String	DEFTARGETAZIMUTH Default property value.
private static String	DEFTARGETHEIGHT Default property value.
private static long	DEFTRACKTIME Time for derotating the telescope.
static Object	DONE
static Object	ERROR
static String	KEY_CONFIRMONTIMEOUT If this is true, we confirm on time-out events in condfirm dialogs.
static String	KEY_DESTINATION The destination where commands should be sent to.
static String	KEY_MOVETIME Time for moving the telescope, maximum.
static String	KEY_OFFSETTIME Time for offsetting the telescop, maximum.
static String	KEY_PRECESS If true, we precess.
static String	KEY_TARGETAZIMUTH Name of the target height parameter.
static String	KEY_TARGETHEIGHT Name of the target height parameter.
static String	KEY_TRACKTIME Time for derotator action the telescope.

Fields inherited from class stella.net.gregor.GetterSetter

KEY_ACKTIMEOUT, KEY_GETTIMEOUT, KEY_STRICTGET, KEY_STRICTSET

Fields inherited from class stella.net.gregor.CommunicationHandler

KEY_RECEIVERWAIT, KEY_SENDERWAIT

Fields inherited from class io.AbstractSocketDriver

KEY_CLOSETIMEOUT, KEY_SOCKETPORT, KEY_SOCKETSERVER, KEY_SOCKETTIMEOUT

Fields inherited from class io.AbstractDriver

KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
GregorDriver(Map<String,String> info) Constructs a new greogor driver.

Method Summary

Modifier and Type	Method and Description
protected boolean	authenticate() Authenticates at the remote host.
boolean	close() On close, we dispose the message pane.
private boolean	close(boolean inreal) On close, we dispose the message pane.
boolean	commenceAbort() Aborts all active commands.
boolean	commenceAbsoluteOffset(double azoff, double altoff) Applies an absolute offset to the telescope axis.
boolean	commenceAbsoluteOffset(double azoff, double altoff, double h) Applies an absolute offset to the telescope axis.
boolean	commenceDerotator(double position) Sets the derotator position in the system's coordinate system, which is in degrees.
boolean	commenceDerotatorOffset(double position) Offsets the derotator position in the system's coordinate system, which is in degrees.
boolean	commenceFocus(double position) Sets a new focus position.
boolean	commenceFocusOffset(double position) Sets a new focus offset.
boolean	commenceGuiding(boolean start) Starts or stops tracking of the telescope and waits until the new tracking state is reached.
boolean	commenceInit() Initializes the telescope.
boolean	commenceMove(double ra, double de) Moves the telescope to the given ra/dec position in J2000.0 equinox.
boolean	commenceMove(double ra, double de, double off, boolean fol) Moves the telescope to the given ra/dec position in J2000.0 equinox.
boolean	commenceMoveAzAlt(double az, double alt) Moves the telescope to the desired alt/az position.
boolean	commencePark() Parks the telescope.
boolean	commenceRelativeOffset(double azoff, double altoff) Adds a current offset to both telescope axis.
boolean	commenceRelativeOffset(double azoff, double altoff, double h) Adds a current offset to both telescope axis.
boolean	commenceTracking(boolean start) Starts or stops tracking of the telescope, but does not block until the telescope is in the new state.
protected boolean	confirmDialog(CommandMessage cm, int tsec) We display a dialog asking for confirmation.
protected boolean	displayDialog(String mess, int tsec) We display a dialog with a certain message.
private double	getHorizontalHeight() Returns the current height as returned by the telescope or throws an error.
TelescopePosition	getPosition() For pointing model issues, Return the current pointing.
boolean	open() On open, we open a plain frame in which further dialogs are displayed.
private boolean	open(boolean inreal) If called with false, opening is not performed
void	registerParameter(Parameter p) A parameter depending command should drain the necessarry information to get valid out of a parameter value.

Methods inherited from class stella.net.gregor.GetterSetter

createGet, createSet, executeGet, executeGet, executeSet, executeSet, init, initiate, messageReceived, removeCycle, toString, waitForComplete

Methods inherited from class stella.net.gregor.CommunicationHandler

putMessage, setMessageListener, startTransmission, stopTransmission

Methods inherited from class io.AbstractSocketDriver

exit, getInputStream, getOutputStream, getSocket, isOpen, setTimeout

Methods inherited from class io.AbstractDriver

createDriver, equals, getDriverName, hashCode

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.Driver

getDriverName, isOpen

Methods inherited from interface util.Initializable

init

Field Detail

DONE

public static final Object DONE

ERROR

public static final Object ERROR

KEY_TARGETHEIGHT

public static final String KEY_TARGETHEIGHT

Name of the target height parameter.

See Also:

Constant Field Values

KEY_TARGETAZIMUTH

public static final String KEY_TARGETAZIMUTH

Name of the target height parameter.

See Also:

Constant Field Values

KEY_CONFIRMONTIMEOUT

public static final String KEY_CONFIRMONTIMEOUT

If this is true, we confirm on time-out events in condfirm dialogs.

See Also:

Constant Field Values

KEY_DESTINATION

public static final String KEY_DESTINATION

The destination where commands should be sent to.

See Also:

Constant Field Values

KEY_MOVETIME

public static final String KEY_MOVETIME

Time for moving the telescope, maximum.

See Also:

Constant Field Values

KEY_OFFSETTIME

public static final String KEY_OFFSETTIME

Time for offsetting the telescop, maximum.

See Also:

Constant Field Values

KEY_TRACKTIME

public static final String KEY_TRACKTIME

Time for derotator action the telescope.

See Also:

Constant Field Values

KEY_PRECESS

public static final String KEY_PRECESS

If true, we precess.

See Also:

Constant Field Values

DEFDESTINATION

private static final String DEFDESTINATION

Default property value.

See Also:

Constant Field Values

DEFTARGETHEIGHT

private static final String DEFTARGETHEIGHT

Default property value.

See Also:

Constant Field Values

DEFTARGETAZIMUTH

private static final String DEFTARGETAZIMUTH

Default property value.

See Also:

Constant Field Values

DEFCONFIRMONTIMEOUT

private static final boolean DEFCONFIRMONTIMEOUT

Default property value.

See Also:

Constant Field Values

DEFMOVETIME

private static final long DEFMOVETIME

Time for moving the telescope, maximum.

See Also:

Constant Field Values

DEFOFFSETTIME

private static final long DEFOFFSETTIME

Time for offsetting the telescop, maximum.

See Also:

Constant Field Values

DEFTRACKTIME

private static final long DEFTRACKTIME

Time for derotating the telescope.

See Also:

Constant Field Values

DEFPRECESS

private static final boolean DEFPRECESS

Default property value.

See Also:

Constant Field Values

aztarget

private Value aztarget

Value stating azimuth of target.

alttarget

private Value alttarget

Value stating elevation of target.

Constructor Detail

GregorDriver

public GregorDriver(Map<String,String> info)

Constructs a new greogor driver.

Method Detail

registerParameter

public void registerParameter(Parameter p)

Description copied from interface: ParameterDepending

A parameter depending command should drain the necessarry information to get valid out of a parameter value. During rendering, parameter depending commands should receive their data through this method. Note that it is always possible to pile up all the information needed for a single command in a single parameter.

Specified by:

registerParameter in interface ParameterDepending

authenticate

protected boolean authenticate()
                        throws IOException

Authenticates at the remote host. This method is called on open, directly after the input and output streams have been opened. The default implementation does nothing here, but subclasses can override.

Overrides:

authenticate in class AbstractSocketDriver

Returns:

True if authentication was successful.

Throws:

IOException

open

public boolean open()
             throws IOException

On open, we open a plain frame in which further dialogs are displayed.

Specified by:

open in interface Driver

Overrides:

open in class AbstractSocketDriver

Returns:

True if initialization was successful.

Throws:

IOException - Exception to throw on connection error

open

private boolean open(boolean inreal)
              throws IOException

If called with false, opening is not performed

Throws:

IOException

close

public boolean close()
              throws IOException

On close, we dispose the message pane.

Specified by:

close in interface Driver

Overrides:

close in class CommunicationHandler

Returns:

True if clean-up was successful.

Throws:

IOException - Exception to throw on disconnection error

close

private boolean close(boolean inreal)
               throws IOException

On close, we dispose the message pane.

Throws:

IOException

displayDialog

protected boolean displayDialog(String mess,
                                int tsec)
                         throws TimeoutException,
                                IOException

We display a dialog with a certain message.

Throws:

TimeoutException

IOException

confirmDialog

protected boolean confirmDialog(CommandMessage cm,
                                int tsec)

We display a dialog asking for confirmation.

commenceInit

public boolean commenceInit()
                     throws IOException,
                            TimeoutException

Initializes the telescope.

Specified by:

commenceInit in interface TelescopeDriver

Throws:

IOException

TimeoutException

commencePark

public boolean commencePark()
                     throws IOException,
                            TimeoutException

Parks the telescope.

Specified by:

commencePark in interface TelescopeDriver

Throws:

IOException

TimeoutException

commenceAbort

public boolean commenceAbort()
                      throws IOException,
                             TimeoutException

Aborts all active commands.

Specified by:

commenceAbort in interface TelescopeDriver

Throws:

IOException

TimeoutException

commenceDerotator

public boolean commenceDerotator(double position)
                          throws IOException

Sets the derotator position in the system's coordinate system, which is in degrees.

Specified by:

commenceDerotator in interface DerotatorAccessible

Throws:

IOException

commenceDerotatorOffset

public boolean commenceDerotatorOffset(double position)
                                throws IOException

Offsets the derotator position in the system's coordinate system, which is in degrees.

Specified by:

commenceDerotatorOffset in interface DerotatorAccessible

Throws:

IOException

commenceFocus

public boolean commenceFocus(double position)
                      throws IOException,
                             TimeoutException

Sets a new focus position. May throw an UnsupportedOperationException if the telescope is not focusable.

Specified by:

commenceFocus in interface FocusAccessible

Parameters:

position - The new focus position.

Throws:

IOException

TimeoutException

commenceFocusOffset

public boolean commenceFocusOffset(double position)
                            throws IOException,
                                   TimeoutException

Sets a new focus offset. May throw an UnsupportedOperationException if the telescope is not focusable.

Specified by:

commenceFocusOffset in interface FocusAccessible

Parameters:

position - The new focus offset, not cummulative.

Throws:

IOException

TimeoutException

commenceMove

public boolean commenceMove(double ra,
                            double de)
                     throws IOException,
                            TimeoutException

Moves the telescope to the given ra/dec position in J2000.0 equinox. Tracking is started.

Specified by:

commenceMove in interface PointingAccessible

Parameters:

ra - Right ascension in degrees.

de - Declination in degrees.

Throws:

IOException

TimeoutException

commenceMove

public boolean commenceMove(double ra,
                            double de,
                            double off,
                            boolean fol)
                     throws IOException,
                            TimeoutException

Moves the telescope to the given ra/dec position in J2000.0 equinox. Additionally, position the derotator to the required offset and set if to follow the tracking. Tracking is started.

Specified by:

commenceMove in interface PointingAccessible

Parameters:

ra - Right ascension in degrees.

de - Declination in degrees.

off - The derotator offset in degress

fol - If true, the derotator follows the tracking.

Throws:

IOException

TimeoutException

commenceMoveAzAlt

public boolean commenceMoveAzAlt(double az,
                                 double alt)
                          throws IOException,
                                 TimeoutException

Moves the telescope to the desired alt/az position. Intended for non-tracking telescope positions.

Specified by:

commenceMoveAzAlt in interface PointingAccessible

Parameters:

az - Astronomical azimuth of desired telescope position.

alt - Height of target of desired telescope position

Throws:

IOException

TimeoutException

commenceTracking

public boolean commenceTracking(boolean start)
                         throws IOException,
                                TimeoutException

Starts or stops tracking of the telescope, but does not block until the telescope is in the new state.

Specified by:

commenceTracking in interface PointingAccessible

Parameters:

start - true for start, false for stop

Throws:

IOException

TimeoutException

commenceGuiding

public boolean commenceGuiding(boolean start)
                        throws IOException,
                               TimeoutException

Starts or stops tracking of the telescope and waits until the new tracking state is reached.

Specified by:

commenceGuiding in interface OffsetAccessible

Parameters:

start - true for start, false for stop

Throws:

IOException

TimeoutException

commenceAbsoluteOffset

public boolean commenceAbsoluteOffset(double azoff,
                                      double altoff,
                                      double h)
                               throws IOException,
                                      TimeoutException

Applies an absolute offset to the telescope axis. On alt/az telescopes this will be an offset in azimuth and altitude. Calling this method repeatedly with the same value will move the telescope only on the first call.

Specified by:

commenceAbsoluteOffset in interface OffsetAccessible

Parameters:

azoff - Offset of azimuth axis in degrees.

altoff - Offset in altitude axis in degrees.

h - Height of telescope in degrees.

Throws:

IOException

TimeoutException

getHorizontalHeight

private double getHorizontalHeight()
                            throws IOException,
                                   TimeoutException

Returns the current height as returned by the telescope or throws an error. Used for correcting offsets if the height is not provided.

Throws:

IOException

TimeoutException

commenceAbsoluteOffset

public boolean commenceAbsoluteOffset(double azoff,
                                      double altoff)
                               throws IOException,
                                      TimeoutException

Applies an absolute offset to the telescope axis. On alt/az telescopes this will be an offset in azimuth and altitude. Calling this method repeatedly with the same value will move the telescope only on the first call.

Specified by:

commenceAbsoluteOffset in interface OffsetAccessible

Parameters:

azoff - Offset of azimuth axis in degrees.

altoff - Offset in altitude axis in degrees.

Throws:

IOException

TimeoutException

commenceRelativeOffset

public boolean commenceRelativeOffset(double azoff,
                                      double altoff)
                               throws IOException,
                                      TimeoutException

Adds a current offset to both telescope axis. On alt/az telescopes this will be an offset in azimuth and altitude.

Specified by:

commenceRelativeOffset in interface OffsetAccessible

Parameters:

azoff - Offset of azimuth axis in degrees.

altoff - Offset in altitude axis in degrees.

Throws:

IOException

TimeoutException

commenceRelativeOffset

public boolean commenceRelativeOffset(double azoff,
                                      double altoff,
                                      double h)
                               throws IOException,
                                      TimeoutException

Adds a current offset to both telescope axis. On alt/az telescopes this will be an offset in azimuth and altitude.

Specified by:

commenceRelativeOffset in interface OffsetAccessible

Parameters:

azoff - Offset of azimuth axis in degrees.

altoff - Offset in altitude axis in degrees.

h - Height of telescope.

Throws:

IOException

TimeoutException

getPosition

public TelescopePosition getPosition()
                              throws IOException,
                                     TimeoutException

For pointing model issues, Return the current pointing. Should query all axes simultaneously, if possible.

Specified by:

getPosition in interface PointingProviding

Throws:

IOException

TimeoutException