CalibrationControlling

All Superinterfaces:

ListenerControlling, Remote

All Known Implementing Classes:

CalibrationMaster
```
public interface CalibrationControlling
extends ListenerControlling
```
An interface defining remote-access capabilities to the adapter master.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`calibrationMove()` Moves calibration unit to ThAr position.
`boolean`	`calibrationOff()` Switches calibration light off.
`boolean`	`calibrationOn()` Switches calibration light on.
`boolean`	`changeCalibrationPosition(String newpos)` To allow the a cahnge of the positioning of the calibration unit during operation.
`boolean`	`changeCalibrationSwitch(String newswitch)` To allow the change of the calibration-light switch without change in the properties this method takes the name of the new calibration-light switch.
`boolean`	`changeFlatFieldPosition(String newpos)` To allow the a change of the positioning of the flat-field unit during operation.
`boolean`	`changeFlatFieldSwitch(String newswitch)` To allow the change of the flat-field light switch without change in the properties this method takes the name of the new flat-field light switch.
`boolean`	`filterOffset(String name, int off)` Stepps the filter wheel with the given name for the desired offset, positive or negative.
`boolean`	`flatFieldMove()` Moves calibration unit to Quartz position.
`boolean`	`flatFieldOff()` Switches flat-fielding light off.
`boolean`	`flatFieldOn()` Switches flat-fielding light.
`String`	`getFilterPosition()` Gets the current fiber input source as the filter wheel position.
`boolean`	`isCalibration()` Returns true if calibration light, i.e.
`boolean`	`isFlatField()` Returns true if flatfield light is switched on.
`boolean`	`prepareCalibration()` Makes the adapter ready for a calibration exposure.
`boolean`	`prepareFlatField()` Makes the adapter ready for a flat field exposure.
`boolean`	`prepareScience()` Makes the adapter ready for a star exposure.
`boolean`	`setFilterPosition(String pos)` Selects fiber input / ccd onput by changing the filter wheel position

Methods inherited from interface stella.rmi.ListenerControlling
automatic, external, getStatus, initialize, manual, park, quit, reset, setPassive

- Method Detail
  - calibrationOn
```
boolean calibrationOn()
               throws RemoteException
```
    Switches calibration light on. Does not change fiber input.
    
    Returns:
    
    True if ThAr was switched on.
    
    Throws:
    
    RemoteException
  - calibrationOff
```
boolean calibrationOff()
                throws RemoteException
```
    Switches calibration light off. Does not change fiber input.
    
    Returns:
    
    True if ThAr was switched off.
    
    Throws:
    
    RemoteException
  - calibrationMove
```
boolean calibrationMove()
                 throws RemoteException
```
    Moves calibration unit to ThAr position. Does not change fiber input.
    
    Returns:
    
    True if ThAr was switched off.
    
    Throws:
    
    RemoteException
  - filterOffset
```
boolean filterOffset(String name,
                     int off)
              throws RemoteException
```
    Stepps the filter wheel with the given name for the desired offset, positive or negative.
    
    Throws:
    
    RemoteException
  - flatFieldOn
```
boolean flatFieldOn()
             throws RemoteException
```
    Switches flat-fielding light. Does not change fiber input.
    
    Returns:
    
    True if halogen lamp was switched on.
    
    Throws:
    
    RemoteException
  - flatFieldOff
```
boolean flatFieldOff()
              throws RemoteException
```
    Switches flat-fielding light off. Does not change fiber input.
    
    Returns:
    
    True if halogen lamp was switched off.
    
    Throws:
    
    RemoteException
  - flatFieldMove
```
boolean flatFieldMove()
               throws RemoteException
```
    Moves calibration unit to Quartz position. Does not change fiber input.
    
    Returns:
    
    True if ThAr was switched off.
    
    Throws:
    
    RemoteException
  - prepareCalibration
```
boolean prepareCalibration()
                    throws RemoteException
```
    Makes the adapter ready for a calibration exposure. Turns on the ThAr lamp, moves the calibration unit and the filterwheel.
    
    Throws:
    
    RemoteException
  - prepareFlatField
```
boolean prepareFlatField()
                  throws RemoteException
```
    Makes the adapter ready for a flat field exposure. Turns on the Quartz lamp, moves the calibration unit and the filterwheel.
    
    Throws:
    
    RemoteException
  - prepareScience
```
boolean prepareScience()
                throws RemoteException
```
    Makes the adapter ready for a star exposure. Turns off the ThAr and Quartz lamps, eventually moves the calibration unit and the filterwheel.
    
    Throws:
    
    RemoteException
  - setFilterPosition
```
boolean setFilterPosition(String pos)
                   throws RemoteException
```
    Selects fiber input / ccd onput by changing the filter wheel position
    
    Returns:
    
    True if filter wheel position was selected.
    
    Throws:
    
    RemoteException
  - getFilterPosition
```
String getFilterPosition()
                  throws RemoteException
```
    Gets the current fiber input source as the filter wheel position. Returns null if no filter wheel is present.
    
    Throws:
    
    RemoteException
  - isCalibration
```
boolean isCalibration()
               throws RemoteException
```
    Returns true if calibration light, i.e. ThAr, is switched on. False may also be returned on adapters that do not support calibration light.
    
    Throws:
    
    RemoteException
  - isFlatField
```
boolean isFlatField()
             throws RemoteException
```
    Returns true if flatfield light is switched on.
    
    Throws:
    
    RemoteException
  - changeCalibrationSwitch
```
boolean changeCalibrationSwitch(String newswitch)
                         throws RemoteException
```
    To allow the change of the calibration-light switch without change in the properties this method takes the name of the new calibration-light switch. Note that the switch must be present in the adapter master's parameter-list, it is not constructed here, only the name of the switch is changed here. Thus, if we start the adapter with two calibration units intalled, we should provide power switches for both in the adapter set: e.g. ThAr1Switch and ThAr2Switch. In this case, we can switch during operation to a new light power switch with a call to this method and 'ThAr2Switch' as an argument. Normally this requires a change in the calibration unit positioning, too, see changeCalibrationPosition(java.lang.String).
    
    Returns:
    
    True, if the new switch was found and can be switched.
    
    Throws:
    
    RemoteException
  - changeFlatFieldSwitch
```
boolean changeFlatFieldSwitch(String newswitch)
                       throws RemoteException
```
    To allow the change of the flat-field light switch without change in the properties this method takes the name of the new flat-field light switch. Note that the switch must be present in the adapter master's parameter-list, it is not constructed here, only the name of the switch is changed here. Thus, if we start the adapter with two calibration units intalled, we should provide power switches for both in the adapter set: e.g. Quartz1Switch and Quartz2Switch. In this case, we can switch during operation to a new light power switch with a call to this method and 'Quartz2Switch' as an argument. Normally this requires a change in the calibration unit positioning, too, see changeCalibrationPosition(java.lang.String).
    
    Returns:
    
    True, if the new switch was found and can be switched.
    
    Throws:
    
    RemoteException
  - changeCalibrationPosition
```
boolean changeCalibrationPosition(String newpos)
                           throws RemoteException
```
    To allow the a cahnge of the positioning of the calibration unit during operation. In case of two different calibrational units present in the adapter, a call to this method allows the use of the spare calibration unit without restarting of the adapter. Note that you might also want to change the calibration power switch, changeCalibrationSwitch(java.lang.String).
    
    Returns:
    
    True if the new position was accepted.
    
    Throws:
    
    RemoteException
  - changeFlatFieldPosition
```
boolean changeFlatFieldPosition(String newpos)
                         throws RemoteException
```
    To allow the a change of the positioning of the flat-field unit during operation. In case of two different flat-field units present in the adapter, a call to this method allows the use of the spare flat-field unit without restarting of the adapter. Note that you might also want to change the flat field power switch, changeFlatFieldSwitch(java.lang.String).
    
    Returns:
    
    True if the new position was accepted.
    
    Throws:
    
    RemoteException

Interface CalibrationControlling

Method Summary

Methods inherited from interface stella.rmi.ListenerControlling

Method Detail

calibrationOn

calibrationOff

calibrationMove

filterOffset

flatFieldOn

flatFieldOff

flatFieldMove

prepareCalibration

prepareFlatField

prepareScience

setFilterPosition

getFilterPosition

isCalibration

isFlatField

changeCalibrationSwitch

changeFlatFieldSwitch

changeCalibrationPosition

changeFlatFieldPosition