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

All Known Implementing Classes:

FilterClampModule, FilterClampXminusModule, FilterClampXplusModule, SimuFilterClampModule

public interface FilterClamp

Method Summary

NumericSensor	getFilterPresenceSensor()
java.lang.String	getName()
FilterClampState	getState()
StatusDataPublishedByClamp	getStatusData()
int	getTickMillis()
boolean	isLocked()
java.lang.String	lock()
java.lang.String	release()
void	setFilterPresenceSensor(NumericSensor filterPresence)
void	setState(FilterClampState state)
java.lang.String	unlock()
void	updateStateWithSensors()

Method Detail

getFilterPresenceSensor

NumericSensor getFilterPresenceSensor()

Returns:

the filterPresence

setFilterPresenceSensor

void setFilterPresenceSensor(NumericSensor filterPresence)

Parameters:

filterPresence - the filterPresence to set

isLocked

boolean isLocked()

setState

void setState(FilterClampState state)

getState

FilterClampState getState()

release

java.lang.String release()
                         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()
                        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()
                      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()