org.lsst.ccs.subsystems.fcs
Class FilterClampModule

java.lang.Object
  java.util.Observable
      org.lsst.ccs.framework.Module
          org.lsst.ccs.subsystems.fcs.common.MobileItemModule
              org.lsst.ccs.subsystems.fcs.FilterClampModule

All Implemented Interfaces:

Serializable, Observer, org.lsst.ccs.framework.Configurable

Direct Known Subclasses:

FilterClampXminusModule, FilterClampXplusModule, SimuFilterClampModule

public abstract class FilterClampModule
extends MobileItemModule

An abstract class which extends Module to model a clamp that holds a filter on the carousel. It implements pattern clampState. See the clampState machine diagram for a carousel clamp. Each clamp on the carousel is coupled with a sensor which detects the presence of a filter. This abstract class provides a method to lock, unlock or release the clamps, and to compute the clampState of the clamp. The clampState of the clamp is computed, updated and published on the status bus each tick of the timer.

Author:

virieux

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

protected FcsEnumerations.FilterClampState	clampState
protected FcsEnumerations.FilterPresenceStatus	filterPresenceStatus
String	publishedByClampOutputName
protected double	temperature
protected long	timeoutRelease
protected long	timeoutUnlock
protected boolean	updatingState

Fields inherited from class org.lsst.ccs.subsystems.fcs.common.MobileItemModule

itemMoving, lock, motionCompleted

Fields inherited from class org.lsst.ccs.framework.Module

environment, log, name, nObserverThreads, registry, tickMillis

Constructor Summary

FilterClampModule()

Method Summary

FcsEnumerations.FilterClampState	computeClampState() Compute the global state of the clamp given the lock sensor and the presence filter sensor state.
ClampActuatorModule	getActuator()
FcsEnumerations.FilterClampState	getClampState() Returns the clampState of the clamp.
int	getFilterPositionMaxValue()
int	getFilterPositionMinValue()
int	getFilterPositionOffset()
int	getFilterPositionValueA()
int	getFilterPositionValueB()
int	getFilterPositionValueC()
Sensor14bits	getFilterPresenceSensor() For encapsulation : we want to access to filterPresenceSensor in sub-packages.
FcsEnumerations.FilterPresenceStatus	getFilterPresenceStatus()
Sensor14bits	getLockSensor()
int	getLockSensorMaxValue()
int	getLockSensorMinValue()
int	getLockSensorOffset()
int	getLockSensorValueA()
int	getLockSensorValueB()
int	getLockSensorValueC()
FcsEnumerations.LockStatus	getLockStatus()
StatusDataPublishedByClamp	getStatusData()
double	getTemperature()
Thermometer	getThermometer()
long	getTimeoutRelease()
long	getTimeoutUnlock()
void	initModule()
boolean	isActionCompleted(FcsEnumerations.MobileItemAction action)
boolean	isFilterEngaged()
boolean	isLocked() This methods returns true if the clamp is locked.
void	postAction(FcsEnumerations.MobileItemAction action)
void	publishTrendingData(StatusDataPublishedByClamp status) Broadcast the trending data on the status bus.
String	release() The clamps on the carousel are locked automaticaly when the filter comes at the standby position.
String	releaseWithThreadSleep() Deprecated.
void	setActuator(ClampActuatorModule actuator)
void	setFilterPositionOffset(int filterPositionOffset)
void	setFilterPositionValueA(int valueA)
void	setFilterPositionValueB(int valueB)
void	setFilterPositionValueC(int valueC)
void	setFilterPresenceSensor(Sensor14bits filterPresenceSensor) for Spring
void	setLockSensor(Sensor14bits lockSensor)
void	setLockSensorOffset(int lockSensorOffset)
void	setLockSensorValueA(int aValue)
void	setLockSensorValueB(int aValue)
void	setLockSensorValueC(int lockSensorValueC)
void	setLockStatus(FcsEnumerations.LockStatus lockStatus)
void	setThermometer(Thermometer thermometer)
void	setTimeoutRelease(long timeoutRelease)
void	setTimeoutUnlock(long timeoutUnlock)
void	startAction(FcsEnumerations.MobileItemAction action)
String	toString()
String	unlock() Unlock the clamp when a filter is locked by the clamp.
String	unlockWithThreadSleep() Deprecated.
void	updateFilterPresenceStatus() Update the field lockPresenceStatus in reading the filter presence sensor.
void	updateLockStatus() Update the field lockStatus in reading the lock sensor.
void	updateStateWithSensors() This method updates the clamp clampState regarding the value returned by the filter presence sensor and the value returned by the method isLocked().
void	updateStateWithSensorsFromSDO() Deprecated.
void	updateStateWithSensorsToCheckIfActionIsCompleted()
double	updateTemperature() This methods read the thermometer, update the field temperature and returns the value sent by the thermometer;

Methods inherited from class org.lsst.ccs.subsystems.fcs.common.MobileItemModule

cancelReadingSensors, executeAction, readSensorsUntilActionIsCompleted, shutdownNow, waitForEndOfAction

Methods inherited from class org.lsst.ccs.framework.Module

alias, change, checkHardware, dropConfigurationContext, getAvailableCommands, getCheckedValueFromConfiguration, getChildren, getContext, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, newConfigurationContext, notifyChange, notifyChangeWithoutPreliminaryChecks, processUpdate, publishData, publishData, publishData, publishData, publishData, publishData, publishData, register, register, removeLogPanicState, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setHandlerLevel, setLogLevel, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, setTickMillis, shutdownCommand, start, startTicking, tick, update

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

clampState

protected FcsEnumerations.FilterClampState clampState

filterPresenceStatus

protected FcsEnumerations.FilterPresenceStatus filterPresenceStatus

temperature

protected double temperature

publishedByClampOutputName

public String publishedByClampOutputName

updatingState

protected volatile boolean updatingState

timeoutUnlock

protected long timeoutUnlock

timeoutRelease

protected long timeoutRelease

Constructor Detail

FilterClampModule

public FilterClampModule()

Method Detail

getActuator

public ClampActuatorModule getActuator()

setActuator

public void setActuator(ClampActuatorModule actuator)

setFilterPositionValueA

public void setFilterPositionValueA(int valueA)

Parameters:

filterPositionValueA - the filterPositionValueA to set

setFilterPositionValueB

public void setFilterPositionValueB(int valueB)

Parameters:

filterPositionValueB - the filterPositionValueB to set

setFilterPositionValueC

public void setFilterPositionValueC(int valueC)

Parameters:

filterPositionValueC - the filterPositionValueC to set

getLockSensorValueA

public int getLockSensorValueA()

Returns:

the lockSensorValueA

setLockSensorValueA

public void setLockSensorValueA(int aValue)

Parameters:

lockSensorValueA - the lockSensorValueA to set

getLockSensorValueB

public int getLockSensorValueB()

Returns:

the lockSensorValueB

setLockSensorValueB

public void setLockSensorValueB(int aValue)

Parameters:

lockSensorValueB - the lockSensorValueB to set

getLockSensorValueC

public int getLockSensorValueC()

setLockSensorValueC

public void setLockSensorValueC(int lockSensorValueC)

getFilterPositionMaxValue

public int getFilterPositionMaxValue()

getFilterPositionMinValue

public int getFilterPositionMinValue()

getLockSensorMaxValue

public int getLockSensorMaxValue()

getLockSensorMinValue

public int getLockSensorMinValue()

setLockSensorOffset

public void setLockSensorOffset(int lockSensorOffset)

getFilterPositionValueA

public int getFilterPositionValueA()

Returns:

the filterPositionValueA

getFilterPositionValueB

public int getFilterPositionValueB()

Returns:

the filterPositionValueB

getFilterPositionValueC

public int getFilterPositionValueC()

Returns:

the filterPositionValueC

getLockSensorOffset

public int getLockSensorOffset()

getFilterPositionOffset

public int getFilterPositionOffset()

setFilterPositionOffset

public void setFilterPositionOffset(int filterPositionOffset)

getFilterPresenceSensor

public Sensor14bits getFilterPresenceSensor()

For encapsulation : we want to access to filterPresenceSensor in sub-packages.

Returns:

the filterPresenceSensor

setFilterPresenceSensor

public void setFilterPresenceSensor(Sensor14bits filterPresenceSensor)

for Spring

Parameters:

filterPresenceSensor - the filterPresenceSensor to set

getLockSensor

public Sensor14bits getLockSensor()

Returns:

the lockSensor

getThermometer

public Thermometer getThermometer()

setThermometer

public void setThermometer(Thermometer thermometer)

setLockSensor

public void setLockSensor(Sensor14bits lockSensor)

Parameters:

lockSensor - the lockSensor to set

getLockStatus

public FcsEnumerations.LockStatus getLockStatus()

Returns:

the lockStatus

setLockStatus

public void setLockStatus(FcsEnumerations.LockStatus lockStatus)

Parameters:

lockStatus - the lockStatus to set

getFilterPresenceStatus

public FcsEnumerations.FilterPresenceStatus getFilterPresenceStatus()

getTemperature

public double getTemperature()

getTimeoutRelease

public long getTimeoutRelease()

setTimeoutRelease

public void setTimeoutRelease(long timeoutRelease)

getTimeoutUnlock

public long getTimeoutUnlock()

setTimeoutUnlock

public void setTimeoutUnlock(long timeoutUnlock)

initModule

public void initModule()

Overrides:

initModule in class org.lsst.ccs.framework.Module

getClampState

public FcsEnumerations.FilterClampState getClampState()

Returns the clampState of the clamp. If the clampState is being updated and waiting for a response from a sensor, this methods waits until the clampState is updated. If the clampState is not being updated, it returns immediatly the clampState.

Returns:

clampState

isLocked

public boolean isLocked()

This methods returns true if the clamp is locked. In the simulator, it is overriden.

Returns:

isFilterEngaged

public boolean isFilterEngaged()

updateFilterPresenceStatus

public void updateFilterPresenceStatus()
                                throws HardwareException

Update the field lockPresenceStatus in reading the filter presence sensor.

Throws:

HardwareError

HardwareException

updateLockStatus

public void updateLockStatus()
                      throws HardwareException

Update the field lockStatus in reading the lock sensor.

Throws:

HardwareError

HardwareException

updateStateWithSensorsFromSDO

@Deprecated
public void updateStateWithSensorsFromSDO()
                                   throws HardwareException

Deprecated.

This method updates the clamp clampState regarding the value returned by the filter presence sensor and the value returned by the method isLocked(). When the update is completed, it sends a signal to threads waiting to get the new value of clampState.

Throws:

HardwareException

updateStateWithSensors

public void updateStateWithSensors()
                            throws HardwareException,
                                   org.lsst.ccs.bus.BadCommandException

This method updates the clamp clampState regarding the value returned by the filter presence sensor and the value returned by the method isLocked(). When the update is completed, it sends a signal to threads waiting to get the new value of clampState.

Throws:

HardwareException

org.lsst.ccs.bus.BadCommandException

publishTrendingData

public void publishTrendingData(StatusDataPublishedByClamp status)

Broadcast the trending data on the status bus.

Parameters:

status -

computeClampState

public FcsEnumerations.FilterClampState computeClampState()

Compute the global state of the clamp given the lock sensor and the presence filter sensor state. This has to be overriden for the clamp X-.

Returns:

clamp state

getStatusData

public StatusDataPublishedByClamp getStatusData()

releaseWithThreadSleep

@Deprecated
public String releaseWithThreadSleep()
                              throws org.lsst.ccs.bus.BadCommandException,
                                     org.lsst.ccs.bus.ErrorInCommandExecutionException,
                                     HardwareException

Deprecated.

The clamps on the carousel are locked automaticaly when the filter comes at the standby position. To be able to lock automaticaly again, it has to be released after each time it has been unlocked. This method is for engineering mode.

Returns:

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException

release

public String release()
               throws HardwareException,
                      org.lsst.ccs.bus.BadCommandException,
                      org.lsst.ccs.bus.ErrorInCommandExecutionException

The clamps on the carousel are locked automaticaly when the filter comes at the standby position. To be able to lock automaticaly again, it has to be released after each time it has been unlocked.

Returns:

Throws:

HardwareError

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException

unlockWithThreadSleep

@Deprecated
public String unlockWithThreadSleep()
                             throws org.lsst.ccs.bus.BadCommandException,
                                    org.lsst.ccs.bus.ErrorInCommandExecutionException,
                                    HardwareException

Deprecated.

Unlock the clamp when a filter is locked by the clamp. This is used only in engineering mode.

Returns:

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException

unlock

public String unlock()
              throws org.lsst.ccs.bus.BadCommandException,
                     org.lsst.ccs.bus.ErrorInCommandExecutionException,
                     HardwareException

Unlock the clamp when a filter is locked by the clamp. This is used only in engineering mode.

Returns:

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException

startAction

public void startAction(FcsEnumerations.MobileItemAction action)
                 throws org.lsst.ccs.bus.BadCommandException,
                        org.lsst.ccs.bus.ErrorInCommandExecutionException

Specified by:

startAction in class MobileItemModule

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

isActionCompleted

public boolean isActionCompleted(FcsEnumerations.MobileItemAction action)

Specified by:

isActionCompleted in class MobileItemModule

postAction

public void postAction(FcsEnumerations.MobileItemAction action)

Specified by:

postAction in class MobileItemModule

updateStateWithSensorsToCheckIfActionIsCompleted

public void updateStateWithSensorsToCheckIfActionIsCompleted()
                                                      throws HardwareException,
                                                             org.lsst.ccs.bus.BadCommandException

Specified by:

updateStateWithSensorsToCheckIfActionIsCompleted in class MobileItemModule

Throws:

HardwareException

org.lsst.ccs.bus.BadCommandException

updateTemperature

public double updateTemperature()
                         throws HardwareException

This methods read the thermometer, update the field temperature and returns the value sent by the thermometer;

Returns:

Throws:

HardwareException

toString

public String toString()

Overrides:

toString in class Object