stella.omc
Interface Shutter

All Superinterfaces:

Driver, MultiAxes, Positioning

All Known Implementing Classes:

WindmillShutter

public interface Shutter
extends Positioning

A shutter is a special positioning driver, that has only two positions: Opened and closed. Due to its importance for exposing scientific measures, we support some additional methods for querying times.

Field Summary

Fields inherited from interface stella.omc.MultiAxes

KEY_INITZERO

Method Summary

long	getClosingTime() Returns the cached time it took for the last closing to commence.
long	getOpeningTime() Returns the cached time it took for the last opening to commence.
long	getTotalOpenTime() Returns the cached time the shutter was totally open in the last exposure.

Methods inherited from interface stella.omc.Positioning

getMaxPosition, getPosition, offset, setPosition, setZeroPosition

Methods inherited from interface stella.omc.MultiAxes

getAxesNames, getMaxPosition, getMaxStep, getPosition, getStep, isContinuous, offset, setPosition, setZeroPosition

Methods inherited from interface io.Driver

close, getDriverName, isOpen, open

Method Detail

getOpeningTime

long getOpeningTime()
                    throws IOException

Returns the cached time it took for the last opening to commence. The time returned must be in ms and should resemble the time it took the shutter from the very first opportunity that light passes through until it was not longer obsuring any light.

Returns:

The last opening time in ms.

Throws:

IOException - If driver communication failed.

getClosingTime

long getClosingTime()
                    throws IOException

Returns the cached time it took for the last closing to commence. The time returned must be in ms and should resemble the time it took the shutter from the very first opportunity that light passes through until it was not longer obsuring any light.

Returns:

The last closing time in ms.

Throws:

IOException - If driver communication failed.

getTotalOpenTime

long getTotalOpenTime()
                      throws IOException

Returns the cached time the shutter was totally open in the last exposure. Totally open means that there were no obscuration whatsoever.

Throws:

IOException