org.lsst.ccs.subsystems.fcs.common
Interface FilterClampState

public interface FilterClampState

Carousel Filter Clamp State. Implements pattern state. If the operations of : lock, unlock and release are the same wether there's a filter in the socket or not, we'll change this to have only 2 states.

Author:

virieux

Field Summary

static org.lsst.ccs.subsystems.fcs.common.ClampedOnFilter	CLAMPEDONFILTER
static org.lsst.ccs.subsystems.fcs.common.ReadyToClampState	READYTOCLAMP
static org.lsst.ccs.subsystems.fcs.common.UnclampedEmpty	UNCLAMPEDEMPTY
static org.lsst.ccs.subsystems.fcs.common.UnclampedOnFilter	UNCLAMPEDONFILTER

Method Summary

java.lang.String	lock(FilterClamp filterClamp)
java.lang.String	release(FilterClamp filterClamp)
java.lang.String	unlock(FilterClamp filterClamp) A method to unlock a carousel clamp which is locked.

Field Detail

READYTOCLAMP

static final org.lsst.ccs.subsystems.fcs.common.ReadyToClampState READYTOCLAMP

CLAMPEDONFILTER

static final org.lsst.ccs.subsystems.fcs.common.ClampedOnFilter CLAMPEDONFILTER

UNCLAMPEDONFILTER

static final org.lsst.ccs.subsystems.fcs.common.UnclampedOnFilter UNCLAMPEDONFILTER

UNCLAMPEDEMPTY

static final org.lsst.ccs.subsystems.fcs.common.UnclampedEmpty UNCLAMPEDEMPTY

Method Detail

unlock

java.lang.String unlock(FilterClamp filterClamp)
                        throws org.lsst.ccs.bus.BadCommandException,
                               org.lsst.ccs.bus.ErrorInCommandExecutionException

A method to unlock a carousel clamp which is locked.

Parameters:

filterClamp -

Returns:

a String : a message for the operator at the console.

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

release

java.lang.String release(FilterClamp filterClamp)
                         throws org.lsst.ccs.bus.BadCommandException,
                                org.lsst.ccs.bus.ErrorInCommandExecutionException

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

lock

java.lang.String lock(FilterClamp filterClamp)
                      throws org.lsst.ccs.bus.BadCommandException,
                             org.lsst.ccs.bus.ErrorInCommandExecutionException

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException