WindmillShutter

java.lang.Object
- util.PropertyContainer
- - io.AbstractDriver
  - - io.AbstractSerialDriver
    - - stella.omc.MotorController
      - stella.omc.WindmillShutter

All Implemented Interfaces:

Driver, Cloneable, MultiAxes, Positioning, Shutter, Initializable, PropertySupplying
```
public class WindmillShutter
extends MotorController
implements Shutter
```
A representation of the shutter used on the SES. It is controlled from within the SES-server, but the calibration master has access to its position and is able to set it to the zero position.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WindmillShutter.ExposureSimulation` Tries to simulate the shutter movement for exposures.
`static class`	`WindmillShutter.FullTurn` Dumps the full status message to system out, performs a full turn and dumps the status again.
`static class`	`WindmillShutter.Parameters` Dumps all parameters to system out.
`static class`	`WindmillShutter.Register` Dumps the register value to system out.

Nested classes/interfaces inherited from class stella.omc.MotorController
MotorController.AxesReset, MotorController.Dump, MotorController.Reset, MotorController.Set, MotorController.Status, MotorController.Step

Nested classes/interfaces inherited from class io.AbstractSerialDriver
AbstractSerialDriver.Available

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`DEFAXIS` The axis name.
`static String`	`DEFDRIVERNAME` The default name of the shutter driver.
`private static boolean`	`DEFINITZERO` Default zero-positioning on init.
`private static long`	`DEFMAXSHUTTERTIME`
`private static String`	`DEFPARAMETERS` The default initializing parameters.
`static String`	`KEY_MAXSHUTTERTIME` Turning times below this are not suspicious.
`static String`	`KEY_PARAMETERS` The parameters to send on init as a map.
`private boolean`	`shutteropen` After init, the shutter is closed.

Fields inherited from class stella.omc.MotorController
axis, FAILED, HOME, KEY_ADDRESS, KEY_AXES, KEY_CONTROLLERTYPE, KEY_EEPROMSTORE, KEY_FAILAXISMOVE, KEY_PROTOCOL, KEY_RESPONSECHOP, KEY_RESPONSEDELAY, KEY_RETRYPOS, KEY_SERIALRETRY, KEY_SLEEPAXISMOVE, KEY_STEPTOLERANCE, KEY_TELEGRAM, KEY_WORKAROUND, MCC, OK, OMC, UNDEFINEDPOSITION

Fields inherited from class io.AbstractSerialDriver
inport, KEY_BAUDRATE, KEY_CLOSETIMEOUT, KEY_DATABIT, KEY_FLOWCONTROL, KEY_INBUFFER, KEY_NOTIFYCOOLDOWN, KEY_OUTBUFFER, KEY_PARITYBIT, KEY_PORTNAME, KEY_RECEIVEFRAMING, KEY_RECEIVETHRESHOLD, KEY_RECEIVETIMEOUT, KEY_STOPBIT, KEY_TIMEOUT, LOCK, outport, STATICLOCK

Fields inherited from class io.AbstractDriver
KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface stella.omc.MultiAxes
KEY_INITZERO

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Constructor and Description

WindmillShutter(Map<String,String> config)
Construct a new shutter similar to a motor controller, but defaulting its name to DEFDRIVERNAME.

Constructors
Constructor and Description
`WindmillShutter(Map<String,String> config)` Construct a new shutter similar to a motor controller, but defaulting its name to `DEFDRIVERNAME`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`closeShutter()`
`long`	`fullTurn()` A method that performs a full turn of the filter wheel.
`double[]`	`getAllParameters()` Gets all parameters, 1-45.
`long`	`getClosingTime()` Returns the last recorded shutter closing time.
`int`	`getMaxPosition()` Returns the maximumk number of allowed positions, which is two.
`int`	`getMaxPosition(String axis)` Compatibility mode.
`int`	`getMaxStep(String axis)` Returns the maximal steps this axis can travel.
`long`	`getOpeningTime()` Returns the last recorded shutter opening time.
`protected Map<String,String>`	`getParametersFor(String ax)` We have only a single axis, thus, always return a single map.
`int`	`getPosition()` Returns the position of the shutter.
`int`	`getPosition(String axis)` Compatibility mode.
`long`	`getTotalOpenTime()` Returns the time the shutter was fully opened.
`boolean`	`isOpenShutter()`
`boolean`	`offset(int diff)` Rotates the desired number of steps from the current position, no nulling.
`boolean`	`offset(String axis, int pos)` Compatibility mode.
`boolean`	`open()` Sets the shutter into zero position after opening.
`boolean`	`openShutter()`
`long`	`quarterTurn()` Rotates a hundred steps with half-step resolution.
`boolean`	`setOldZeroPosition()` If the driver has been opened, we set the position of the WindmillShutter to the zero position.
`boolean`	`setPosition(int onoff)` This shutter runs a dedicated program, it cannot be set from the outside.
`boolean`	`setPosition(String axis, int pos)` Compatibility mode.
`boolean`	`setZeroPosition()` Make the new zero positioning in the 'regular' way by issuing a X0-H
`boolean`	`setZeroPosition(String axis)` Compatibility mode.

Methods inherited from class stella.omc.MotorController
axisStop, encapsulate, ensureCommand, errorPower, errorStep, errorStop, getAxesNames, getControllerParameter, getControllerParameterArray, getControllerType, getStatus, getStatus, getStep, getStepResolution, init, isContinuous, powerOff, powerOn, readString, readString, remote, reset, resetAxis, setControllerParameter, waitWhileAxisMoving, waitWhileAxisMoving, writeCommand, writeCommand, writeString, writeString

Methods inherited from class io.AbstractSerialDriver
close, createPortEventListener, createPortEventListener, deregisterSoleEventListener, disableEvent, enableEvent, getDriverName, isOpen, registerSoleEventListener, resetOriginalParameters

Methods inherited from class io.AbstractDriver
createDriver, equals, 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, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface stella.omc.MultiAxes
getAxesNames, getStep, isContinuous

Methods inherited from interface io.Driver
close, getDriverName, isOpen

Methods inherited from interface util.Initializable
init

- Field Detail
  - KEY_PARAMETERS
```
public static final String KEY_PARAMETERS
```
    The parameters to send on init as a map.
    
    See Also:
    
    Constant Field Values
  - KEY_MAXSHUTTERTIME
```
public static final String KEY_MAXSHUTTERTIME
```
    Turning times below this are not suspicious.
    
    See Also:
    
    Constant Field Values
  - DEFDRIVERNAME
```
public static final String DEFDRIVERNAME
```
    The default name of the shutter driver.
    
    See Also:
    
    Constant Field Values
  - DEFINITZERO
```
private static final boolean DEFINITZERO
```
    Default zero-positioning on init.
    
    See Also:
    
    Constant Field Values
  - DEFAXIS
```
private static final String DEFAXIS
```
    The axis name.
    
    See Also:
    
    Constant Field Values
  - DEFPARAMETERS
```
private static final String DEFPARAMETERS
```
    The default initializing parameters.
    
    See Also:
    
    Constant Field Values
  - DEFMAXSHUTTERTIME
```
private static final long DEFMAXSHUTTERTIME
```
    See Also:
    
    Constant Field Values
  - shutteropen
```
private boolean shutteropen
```
    After init, the shutter is closed.
- Constructor Detail
  - WindmillShutter
```
public WindmillShutter(Map<String,String> config)
```
    Construct a new shutter similar to a motor controller, but defaulting its name to DEFDRIVERNAME.
- Method Detail
  - getParametersFor
```
protected Map<String,String> getParametersFor(String ax)
```
    We have only a single axis, thus, always return a single map.
    
    Specified by:
    
    getParametersFor in class MotorController
  - open
```
public boolean open()
             throws IOException
```
    Sets the shutter into zero position after opening.
    
    Specified by:
    
    open in interface Driver
    
    Overrides:
    
    open in class MotorController
    
    Returns:
    
    True if initialization was successful.
    
    Throws:
    
    IOException
  - setPosition
```
public boolean setPosition(String axis,
                           int pos)
                    throws IOException
```
    Compatibility mode.
    
    Specified by:
    
    setPosition in interface MultiAxes
    
    Parameters:
    
    axis - The name of the axis to be zero-setted.
    
    pos - The numbered position to be attained.
    
    Returns:
    
    True on success
    
    Throws:
    
    IOException - If driver communication failed.
  - offset
```
public boolean offset(String axis,
                      int pos)
               throws IOException
```
    Compatibility mode.
    
    Specified by:
    
    offset in interface MultiAxes
    
    Parameters:
    
    axis - The name of the axis to be zero-setted.
    
    pos - The number of step, positiv or negative in driver-specific coordinates.
    
    Returns:
    
    True on success
    
    Throws:
    
    IOException - If driver communication failed.
  - setZeroPosition
```
public boolean setZeroPosition(String axis)
                        throws IOException
```
    Compatibility mode.
    
    Specified by:
    
    setZeroPosition in interface MultiAxes
    
    Parameters:
    
    axis - The name of the axis to be zero-setted.
    
    Returns:
    
    True on success
    
    Throws:
    
    IOException - If driver communication failed.
  - getPosition
```
public int getPosition(String axis)
                throws IOException
```
    Compatibility mode.
    
    Specified by:
    
    getPosition in interface MultiAxes
    
    Parameters:
    
    axis - The name of the axis to be zero-setted.
    
    Returns:
    
    A integer denoting one of the attainable positions.
    
    Throws:
    
    IOException - If driver communication failed.
  - getMaxPosition
```
public int getMaxPosition(String axis)
                   throws IOException
```
    Compatibility mode.
    
    Specified by:
    
    getMaxPosition in interface MultiAxes
    
    Parameters:
    
    axis - String representing the selected axis.
    
    Throws:
    
    IOException
  - getMaxStep
```
public int getMaxStep(String axis)
               throws IOException
```
    Description copied from interface: MultiAxes
    
    Returns the maximal steps this axis can travel. Used together with MultiAxes.getMaxPosition(java.lang.String) to estimate the number of steps per position.
    
    Specified by:
    
    getMaxStep in interface MultiAxes
    
    Throws:
    
    IOException
  - setZeroPosition
```
public boolean setZeroPosition()
                        throws IOException
```
    Make the new zero positioning in the 'regular' way by issuing a X0-H
    
    Specified by:
    
    setZeroPosition in interface Positioning
    
    Returns:
    
    True on success
    
    Throws:
    
    IOException - If driver communication failed.
  - setOldZeroPosition
```
public boolean setOldZeroPosition()
                           throws IOException
```
    If the driver has been opened, we set the position of the WindmillShutter to the zero position. This should be done mor often than opening the driver.
    
    Throws:
    
    IOException
  - getPosition
```
public int getPosition()
                throws IOException
```
    Returns the position of the shutter. It has only two positions, zero or one. Zero is probably closed.
    
    Specified by:
    
    getPosition in interface Positioning
    
    Returns:
    
    -1 on failure.
    
    Throws:
    
    IOException - If driver communication failed.
  - getMaxPosition
```
public int getMaxPosition()
```
    Returns the maximumk number of allowed positions, which is two.
    
    Specified by:
    
    getMaxPosition in interface Positioning
  - setPosition
```
public boolean setPosition(int onoff)
```
    This shutter runs a dedicated program, it cannot be set from the outside.
    
    Specified by:
    
    setPosition in interface Positioning
    
    Returns:
    
    -1 on failure.
  - offset
```
public boolean offset(int diff)
               throws IOException
```
    Rotates the desired number of steps from the current position, no nulling.
    
    Specified by:
    
    offset in interface Positioning
    
    Throws:
    
    IOException
  - getOpeningTime
```
public long getOpeningTime()
                    throws IOException
```
    Returns the last recorded shutter opening time. This is the time from setting the movement command on the axis until it got to rest.
    
    Specified by:
    
    getOpeningTime in interface Shutter
    
    Returns:
    
    A positive time in ms.
    
    Throws:
    
    IOException - If driver communication failed.
  - getClosingTime
```
public long getClosingTime()
                    throws IOException
```
    Returns the last recorded shutter closing time. This is the time from setting the movement command on the axis until it got to rest.
    
    Specified by:
    
    getClosingTime in interface Shutter
    
    Returns:
    
    A positive time in ms.
    
    Throws:
    
    IOException - If driver communication failed.
  - getTotalOpenTime
```
public long getTotalOpenTime()
                      throws IOException
```
    Returns the time the shutter was fully opened. This is the time elapsed from axis stop after opening until the controller set the shutter pin high(low?) again for closing.
    
    Specified by:
    
    getTotalOpenTime in interface Shutter
    
    Throws:
    
    IOException
  - fullTurn
```
public long fullTurn()
              throws IOException
```
    A method that performs a full turn of the filter wheel.
    
    Throws:
    
    IOException
  - openShutter
```
public boolean openShutter()
                    throws IOException
```
    Specified by:
    
    openShutter in interface Shutter
    
    Throws:
    
    IOException
  - closeShutter
```
public boolean closeShutter()
                     throws IOException
```
    Specified by:
    
    closeShutter in interface Shutter
    
    Throws:
    
    IOException
  - isOpenShutter
```
public boolean isOpenShutter()
```
    Specified by:
    
    isOpenShutter in interface Shutter
  - getAllParameters
```
public double[] getAllParameters()
                          throws IOException
```
    Gets all parameters, 1-45.
    
    Throws:
    
    IOException
  - quarterTurn
```
public long quarterTurn()
                 throws IOException
```
    Rotates a hundred steps with half-step resolution.
    
    Returns:
    
    A time estimate of the turning time.
    
    Throws:
    
    IOException

Class WindmillShutter

Nested Class Summary

Nested classes/interfaces inherited from class stella.omc.MotorController

Nested classes/interfaces inherited from class io.AbstractSerialDriver

Field Summary

Fields inherited from class stella.omc.MotorController

Fields inherited from class io.AbstractSerialDriver

Fields inherited from class io.AbstractDriver

Fields inherited from class util.PropertyContainer

Fields inherited from interface stella.omc.MultiAxes

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class stella.omc.MotorController

Methods inherited from class io.AbstractSerialDriver

Methods inherited from class io.AbstractDriver

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Methods inherited from interface stella.omc.MultiAxes

Methods inherited from interface io.Driver

Methods inherited from interface util.Initializable

Field Detail

KEY_PARAMETERS

KEY_MAXSHUTTERTIME

DEFDRIVERNAME

DEFINITZERO

DEFAXIS

DEFPARAMETERS

DEFMAXSHUTTERTIME

shutteropen

Constructor Detail

WindmillShutter

Method Detail

getParametersFor

open

setPosition

offset

setZeroPosition

getPosition

getMaxPosition

getMaxStep

setZeroPosition

setOldZeroPosition

getPosition

getMaxPosition

setPosition

offset

getOpeningTime

getClosingTime

getTotalOpenTime

fullTurn

openShutter

closeShutter

isOpenShutter

getAllParameters

quarterTurn