stella.telescope

Class AbstractRpcTelescope

java.lang.Object

util.PropertyContainer

util.PropertyResources

stella.telescope.AbstractRpcTelescope

All Implemented Interfaces:

Driver, Cloneable, DerotatorAccessible, FocusAccessible, OffsetAccessible, PointingAccessible, TelescopeDriver, Initializable, PropertySupplying, ResourceSupplying

public abstract class AbstractRpcTelescope
extends PropertyResources
implements TelescopeDriver

Generic interface to classes that talk to an RPC-server TCS.

Author:

wooz

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRpcTelescope(Map<String,String> props)

Method Summary

Modifier and Type	Method and Description
boolean	close() Performs clean-up step when the driver is unloaded.
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.
String	getDriverName() If more than one driver of a certain class is present, but registering is only allowed to a certain driver, we can use this method to distinguish between different instances of the driver.
boolean	isOpen() Queries the initalization status of the driver.
boolean	open() Performs initialization steps when the driver is loaded for the first time.

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, 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, isNew, parseObject, parseObject, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface util.Initializable

init

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Constructor Detail

AbstractRpcTelescope

protected AbstractRpcTelescope(Map<String,String> props)

Parameters:

props -

Method Detail

commenceAbort

public boolean commenceAbort()
                      throws IOException,
                             TimeoutException

Description copied from interface: TelescopeDriver

Aborts all active commands.

Specified by:

commenceAbort in interface TelescopeDriver

Throws:

IOException

TimeoutException

commenceAbsoluteOffset

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

Description copied from interface: OffsetAccessible

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

commenceAbsoluteOffset

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

Description copied from interface: OffsetAccessible

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

commenceDerotator

public boolean commenceDerotator(double position)
                          throws IOException,
                                 TimeoutException

Description copied from interface: DerotatorAccessible

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

Specified by:

commenceDerotator in interface DerotatorAccessible

Throws:

IOException

TimeoutException

commenceDerotatorOffset

public boolean commenceDerotatorOffset(double position)
                                throws IOException,
                                       TimeoutException

Description copied from interface: DerotatorAccessible

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

Specified by:

commenceDerotatorOffset in interface DerotatorAccessible

Throws:

IOException

TimeoutException

commenceFocus

public boolean commenceFocus(double position)
                      throws IOException,
                             TimeoutException

Description copied from interface: FocusAccessible

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

Description copied from interface: FocusAccessible

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

commenceGuiding

public boolean commenceGuiding(boolean start)
                        throws IOException,
                               TimeoutException

Description copied from interface: OffsetAccessible

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

commenceInit

public boolean commenceInit()
                     throws IOException,
                            TimeoutException

Description copied from interface: TelescopeDriver

Initializes the telescope.

Specified by:

commenceInit in interface TelescopeDriver

Throws:

IOException

TimeoutException

commenceMove

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

Description copied from interface: PointingAccessible

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

Description copied from interface: PointingAccessible

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

Description copied from interface: PointingAccessible

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

commencePark

public boolean commencePark()
                     throws IOException,
                            TimeoutException

Description copied from interface: TelescopeDriver

Parks the telescope.

Specified by:

commencePark in interface TelescopeDriver

Throws:

IOException

TimeoutException

commenceRelativeOffset

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

Description copied from interface: OffsetAccessible

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

Description copied from interface: OffsetAccessible

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

commenceTracking

public boolean commenceTracking(boolean start)
                         throws IOException,
                                TimeoutException

Description copied from interface: PointingAccessible

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

close

public boolean close()
              throws IOException

Description copied from interface: Driver

Performs clean-up step when the driver is unloaded. A serial-port driver will probably close the serial port in this method.

Specified by:

close in interface Driver

Returns:

True if clean-up was successful.

Throws:

IOException

getDriverName

public String getDriverName()

Description copied from interface: Driver

If more than one driver of a certain class is present, but registering is only allowed to a certain driver, we can use this method to distinguish between different instances of the driver.

Specified by:

getDriverName in interface Driver

isOpen

public boolean isOpen()

Description copied from interface: Driver

Queries the initalization status of the driver. If the driver has been successfully initalized this method should return true.

Specified by:

isOpen in interface Driver

Returns:

True, if a previous initialization was successful

open

public boolean open()
             throws IOException

Description copied from interface: Driver

Performs initialization steps when the driver is loaded for the first time. A driver that communicates with the serial port will open the port in this instance.

Specified by:

open in interface Driver

Returns:

True if initialization was successful.

Throws:

IOException