org.lsst.ccs.subsystems.fcs.common

Interface FilterHolder

All Known Implementing Classes:

Autochanger, Carousel, FakeFilterHolder, FakeFilterHolderForCarouselStandalone, Loader, SimuAutochanger, SimuCarousel, SimuLoader

public interface FilterHolder

The autochanger module for the whole Filter Exchange System or the fake autochanger module implements this interface. In the case of the whole Filter Exchange System, when there is a carousel, an autochanger and a loader, the sensors of the autochanger latches tell us if the filter is held by autochanger or not. When carousel or loader are in standalone mode, there is no autochanger hardware. But sometimes we want to test that the hardware as if the autochanger was holding a filter. This is done usualy with a numeric switch and a sensor that can be read to know the value of the switch.

Author:

virieux

Method Summary

Modifier and Type	Method and Description
default int	getFilterID()
default boolean	isAtHandoff() This method returns true if the autochanger trucks are at HANDOFF position, false otherwise.
default boolean	isAtOnline() This method returns true if the autochanger trucks are at ONLINE position, false otherwise.
default boolean	isAtStandby() This method returns true if the autochanger trucks are at STANDBY position, false otherwise.
default boolean	isHoldingFilter() Return true if the FilterHolder is holding a filter, false otherwise.
default boolean	isNotHoldingFilter() Return true if FilterHolder is NOT holding filter, false otherwise.
default void	updateStateWithSensors() This method read values sent by the sensors and update state from this new values.

Method Detail

isHoldingFilter

default boolean isHoldingFilter()

Return true if the FilterHolder is holding a filter, false otherwise. Example : latches CLOSED on filter (AF3=1)

Returns:

true if holding filter

Throws:

FcsHardwareException

isNotHoldingFilter

default boolean isNotHoldingFilter()

Return true if FilterHolder is NOT holding filter, false otherwise. Example : latches OPENED (AF0=1) It can't be just !isHoldingFilter() because hardware can be in an intermediate state. For example, when opening or closing autochanger latches, latches go in state IN_TRAVEL. So we can have state where AF3=0 and AF2=0

Returns:

true if NOT holding filter

isAtHandoff

default boolean isAtHandoff()

This method returns true if the autochanger trucks are at HANDOFF position, false otherwise.

Returns:

isAtStandby

default boolean isAtStandby()

This method returns true if the autochanger trucks are at STANDBY position, false otherwise.

Returns:

isAtOnline

default boolean isAtOnline()

This method returns true if the autochanger trucks are at ONLINE position, false otherwise.

Returns:

updateStateWithSensors

default void updateStateWithSensors()

This method read values sent by the sensors and update state from this new values.

Throws:

FcsHardwareException

getFilterID

default int getFilterID()