org.minetti.astrodevice.common.orb
Interface DomeOrbProcess

All Superinterfaces:

DeviceOrbProcess, Remote

public interface DomeOrbProcess
extends DeviceOrbProcess, Remote

ORB process on domes.

Author:

Jean-Philippe MINETTI

Method Summary

void	abortSlew(long domeId) Immediately cancels current dome operation.
void	closeShutter(long domeId) Closes shutter or otherwise shield telescope from the sky.
void	findHome(long domeId) Starts operation to search for the dome home position.
double	getAltitude(long domeId) Returns the dome altitude.
double	getAzimuth(long domeId) Returns the dome azimuth.
DomeCapabilities	getCapabilities(long domeId) Returns all capabilities of a dome.
ShutterStatus	getShutterStatus(long domeId) Returns the status of the dome shutter or roll-off roof.
boolean	isAtHome(long domeId) Returns TRUE if the dome is in the home position.
boolean	isParked(long domeId) Returns TRUE if the dome is in the programmed park position.
boolean	isSlaved(long domeId) Returns TRUE if the dome is slaved to the telescope in its hardware, else FALSE.
boolean	isSlewing(long domeId) Returns TRUE if any part of the dome is currently moving, FALSE if all dome components are steady.
void	openShutter(long domeId) Open shutter or otherwise expose telescope to the sky.
void	park(long domeId) Rotates dome in azimuth to park position.
void	setPark(long domeId) Sets the current azimuth, altitude position of dome to be the park position.
void	setSlaved(long domeId, boolean slaved) Sets TRUE if the dome is slaved to the telescope in its hardware, else FALSE.
void	slewToAltitude(long domeId, double altitude) Slews the dome to the given altitude position.
void	slewToAzimuth(long domeId, double azimuth) Slews the dome to the given azimuth position.
void	syncToAzimuth(long domeId, double azimuth) Synchronizes the current position of the dome to the given azimuth.

Methods inherited from interface org.minetti.astrodevice.common.orb.DeviceOrbProcess

action, commandBlind, commandBoolean, commandString, getDescription, getDeviceList, getDeviceName, getDriverInfo, getDriverVersion, getInterfaceVersion, getPluginName, getSupportedActions, isConnected, setConnected, showSetupDialog

Method Detail

getCapabilities

DomeCapabilities getCapabilities(long domeId)
                                 throws RemoteException

Returns all capabilities of a dome.

Parameters:

domeId - Dome identifier.

Returns:

Object representing all capabilities of a dome.

Throws:

RemoteException - Exception if an error occurred.

openShutter

void openShutter(long domeId)
                 throws RemoteException

Open shutter or otherwise expose telescope to the sky.

Raises an error if not supported or if a communications failure occurs.

Parameters:

domeId - Dome identifier.

Throws:

RemoteException - Exception if an error occurred.

closeShutter

void closeShutter(long domeId)
                  throws RemoteException

Closes shutter or otherwise shield telescope from the sky.

Parameters:

domeId - Dome identifier.

Throws:

RemoteException - Exception if an error occurred.

getShutterStatus

ShutterStatus getShutterStatus(long domeId)
                               throws RemoteException

Returns the status of the dome shutter or roll-off roof.

Raises an error only if no shutter control. If actual shutter status can not be read, then reports back the last shutter state.

Parameters:

domeId - Dome identifier.

Returns:

Status of the dome shutter or roll-off roof.

Throws:

RemoteException - Exception if an error occurred.

findHome

void findHome(long domeId)
              throws RemoteException

Starts operation to search for the dome home position.

After home position is established initializes getAzimuth(long) to the default value and sets the isAtHome(long) flag. Exception if not supported or communications failure. Raises an error if isSlaved(long) is TRUE.

Parameters:

domeId - Dome identifier.

Throws:

RemoteException - Exception if an error occurred.

isAtHome

boolean isAtHome(long domeId)
                 throws RemoteException

Returns TRUE if the dome is in the home position. Raises an error if not supported.

This is normally used following a findHome(long) operation. The value is reset with any azimuth slew operation that moves the dome away from the home position.

isAtHome may also become TRUE during normal slew operations, if the dome passes through the home position and the dome controller hardware is capable of detecting that; or at the end of a slew operation if the dome comes to rest at the home position.

The home position is normally defined by a hardware sensor positioned around the dome circumference and represents a fixed, known azimuth reference.

For some devices, the home position may represent a small range of azimuth values, rather than a discrete value, since dome inertia, the resolution of the home position sensor and/or the azimuth encoder may be insufficient to return the exact same azimuth value on each occasion. Some dome controllers, on the other hand, will always force the azimuth reading to a fixed value whenever the home position sensor is active. Because of these potential differences in behaviour, applications should not rely on the reported azimuth position being identical each time isAtHome is set TRUE.

Parameters:

domeId - Dome identifier.

Returns:

TRUE if the dome is in the home position.

Throws:

RemoteException - Exception if an error occurred.

park

void park(long domeId)
          throws RemoteException

Rotates dome in azimuth to park position.

After assuming programmed park position, sets isParked(long) flag. Raises an error if isSlaved(long) is TRUE, or if not supported, or if a communications failure has occurred.

Parameters:

domeId - Dome identifier.

Throws:

RemoteException - Exception if an error occurred.

isParked

boolean isParked(long domeId)
                 throws RemoteException

Returns TRUE if the dome is in the programmed park position.

Set only following a park(long) operation and reset with any slew operation. Raises an error if not supported.

Parameters:

domeId - Dome identifier.

Returns:

TRUE if the dome is in the programmed park position.

Throws:

RemoteException - Exception if an error occurred.

setPark

void setPark(long domeId)
             throws RemoteException

Sets the current azimuth, altitude position of dome to be the park position.

Raises an error if not supported or if a communications failure occurs.

Parameters:

domeId - Dome identifier.

Throws:

RemoteException - Exception if an error occurred.

getAzimuth

double getAzimuth(long domeId)
                  throws RemoteException

Returns the dome azimuth.

Raises an error only if no azimuth control. If actual dome azimuth can not be read, then reports back last slew position.

Parameters:

domeId - Dome identifier.

Returns:

Dome azimuth (degrees, North zero and increasing clockwise, i.e., 90 East, 180 South, 270 West).

Throws:

RemoteException - Exception if an error occurred.

getAltitude

double getAltitude(long domeId)
                   throws RemoteException

Returns the dome altitude.

Raises an error only if no altitude control. If actual dome altitude can not be read, then reports back the last slew position.

Parameters:

domeId - Dome identifier.

Returns:

Dome altitude (degrees, horizon zero and increasing positive to 90 zenith).

Throws:

RemoteException - Exception if an error occurred.

isSlewing

boolean isSlewing(long domeId)
                  throws RemoteException

Returns TRUE if any part of the dome is currently moving, FALSE if all dome components are steady.

Raises an error if isSlaved(long) is TRUE, if not supported, if a communications failure occurs, or if the dome can not reach indicated azimuth.

Parameters:

domeId - Dome identifier.

Returns:

TRUE if any part of the dome is currently moving.

Throws:

RemoteException - Exception if an error occurred.

slewToAltitude

void slewToAltitude(long domeId,
                    double altitude)
                    throws RemoteException

Slews the dome to the given altitude position.

Raises an error if isSlaved(long) is TRUE, if not supported, if a communications failure occurs, or if the dome can not reach indicated altitude.

Parameters:

domeId - Dome identifier.

altitude - Target dome altitude (degrees, horizon zero and increasing positive to 90 zenith).

Throws:

RemoteException - Exception if an error occurred.

slewToAzimuth

void slewToAzimuth(long domeId,
                   double azimuth)
                   throws RemoteException

Slews the dome to the given azimuth position.

Raises an error if isSlaved(long) is TRUE, if not supported, if a communications failure occurs, or if the dome can not reach indicated azimuth.

Parameters:

domeId - Dome identifier.

azimuth - Target azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West).

Throws:

RemoteException - Exception if an error occurred.

abortSlew

void abortSlew(long domeId)
               throws RemoteException

Immediately cancels current dome operation.

Calling this method will immediately disable hardware slewing (isSlaved(long) will become FALSE). Raises an error if a communications failure occurs, or if the command is known to have failed.

Parameters:

domeId - Dome identifier.

Throws:

RemoteException - Exception if an error occurred.

syncToAzimuth

void syncToAzimuth(long domeId,
                   double azimuth)
                   throws RemoteException

Synchronizes the current position of the dome to the given azimuth.

Raises an error if not supported or if a communications failure occurs.

Parameters:

domeId - Dome identifier.

azimuth - Target azimuth (degrees, North zero and increasing clockwise. i.e., 90 East, 180 South, 270 West).

Throws:

RemoteException - Exception if an error occurred.

isSlaved

boolean isSlaved(long domeId)
                 throws RemoteException

Returns TRUE if the dome is slaved to the telescope in its hardware, else FALSE.

Always returns FALSE if hardware slaving is not supported (see getCapabilities(long).canSlave()).

Parameters:

domeId - Dome identifier.

Returns:

TRUE if the dome is slaved to the telescope in its hardware, else FALSE.

Throws:

RemoteException - Exception if an error occurred.

setSlaved

void setSlaved(long domeId,
               boolean slaved)
               throws RemoteException

Sets TRUE if the dome is slaved to the telescope in its hardware, else FALSE.

Set this setting to TRUE to enable dome-telescope hardware slaving, if supported (see getCapabilities(long).canSlave()). Raises an exception on any attempt to call this method if hardware slaving is not supported.

Parameters:

domeId - Dome identifier.

slaved - TRUE if the dome is slaved to the telescope in its hardware, else FALSE.

Throws:

RemoteException - Exception if an error occurred.