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

All Known Implementing Classes:

CanOpenFilterClampModule, FilterClampModule, FilterClampXminusModule, FilterClampXplusModule, SimuFilterClampModule, SimuFilterClampXminusModule, SimuFilterClampXplusModule

public interface FilterClamp

Method Summary

Sensor	getFilterPresenceSensor()
java.lang.String	getName()
FilterClampState	getState()
StatusDataPublishedByClamp	getStatusData()
int	getTickMillis()
boolean	isFilterEngaged()
boolean	isLocked()
java.lang.String	release(Actuator actuator)
void	setState(FilterClampState state)
java.lang.String	unlock(Actuator actuator)
void	updateStateWithSensors()

Method Detail

getFilterPresenceSensor

Sensor getFilterPresenceSensor()

Returns:

the filterPresence

isLocked

boolean isLocked()

setState

void setState(FilterClampState state)

getState

FilterClampState getState()

release

java.lang.String release(Actuator actuator)
                         throws org.lsst.ccs.bus.BadCommandException,
                                org.lsst.ccs.bus.ErrorInCommandExecutionException

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

unlock

java.lang.String unlock(Actuator actuator)
                        throws org.lsst.ccs.bus.BadCommandException,
                               org.lsst.ccs.bus.ErrorInCommandExecutionException

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

updateStateWithSensors

void updateStateWithSensors()

getName

java.lang.String getName()

getTickMillis

int getTickMillis()

getStatusData

StatusDataPublishedByClamp getStatusData()

isFilterEngaged

boolean isFilterEngaged()