org.lsst.ccs.subsystems.fcs.simulation

Class SimuCarouselClampModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.common.MobileItemModule

org.lsst.ccs.subsystems.fcs.CarouselClampModule

org.lsst.ccs.subsystems.fcs.simulation.SimuCarouselClampModule

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.SignalHandler

Direct Known Subclasses:

SimuCarouselClampXminusModule

public class SimuCarouselClampModule
extends CarouselClampModule

A very basic simulated filter clamp module. It has no sensor to know if the clamp is locked or not. This clamp is locked when the clamps actuator of the carousel are off. And its filter presence sensor is configured to returns the value we expect!

Author:

virieux

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

Fields

Modifier and Type	Field and Description
protected CarouselModule	carousel
protected Filter	dummyFilter

Fields inherited from class org.lsst.ccs.subsystems.fcs.CarouselClampModule

actuator, clampState, currentToMaintainUnlocked, currentToUnlock, filterPresenceStatus, temperature, timeoutForReleasing, timeoutForUnlocking, updatingState

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

currentAction, fcslog, haltRequired, hasToWaitForEndOfAction, lock, motionCompleted, moving, stopRequired

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

environment, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description

SimuCarouselClampModule(String aName, int aTickMillis, Sensor14bits filterPresenceSensor, Sensor14bits lockSensor, Thermometer thermometer, int filterPositionValueA, int filterPositionValueB, int filterPositionValueC, int filterPositionOffset, int lockSensorValueA, int lockSensorValueB, int lockSensorValueC, int lockSensorOffset, int timeoutForUnlocking, int timeoutForReleasing, int currentToUnlock, int currentToMaintainUnlocked)

Method Summary

Modifier and Type	Method and Description
Filter	getDummyFilter()
void	initModule()
void	setDummyFilter(Filter dummyFilter)
void	startAction(FcsEnumerations.MobileItemAction action)
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().
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.CarouselClampModule

abortAction, checkHardware, computeClampState, getActuator, getClampState, getCurrentToUnlock, getFilterPositionMaxValue, getFilterPositionMinValue, getFilterPositionOffset, getFilterPositionValueA, getFilterPositionValueB, getFilterPositionValueC, getFilterPresenceSensor, getFilterPresenceStatus, getLockSensor, getLockSensorMaxValue, getLockSensorMinValue, getLockSensorOffset, getLockSensorValueA, getLockSensorValueB, getLockSensorValueC, getLockStatus, getStatusData, getTemperature, getThermometer, getTimeoutRelease, getTimeoutUnlock, isActionCompleted, isFilterEngaged, isHardwareReady, isLocked, postAction, publishData, quickStopAction, release, setActuator, setFilterPositionOffset, setFilterPositionValueA, setFilterPositionValueB, setFilterPositionValueC, setLockSensorOffset, setLockSensorValueA, setLockSensorValueB, setLockSensorValueC, setLockStatus, setTimeoutRelease, setTimeoutUnlock, tick, toString, unlock, updateFilterPresenceStatus, updateLockStatus, updateStateWithSensorsFromSDO, updateStateWithSensorsToCheckIfActionIsCompleted

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

abort, abort, checkStarted, checkStopped, executeAction, getHaltRequired, isMoving, quickstop, readSensorsUntilActionIsCompleted, shutdownNow, signal, stop, stop

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

alias, getComponentTree, getEnvironment, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, percolateSignal, postStart, processUpdate, sendSignal, sendSignalWithTimeLimit, setEnvironment, setName, setNObserverThreads, setObservables, setTickMillis, startTicking, 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

Methods inherited from interface org.lsst.ccs.framework.Configurable

change, getCheckedValueFromConfiguration, getChildren, getComponentByName, getFullPath, getParent, getParentObject, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, proceduralWalk, start, treeWalk

Field Detail

carousel

protected CarouselModule carousel

dummyFilter

protected Filter dummyFilter

Constructor Detail

SimuCarouselClampModule

public SimuCarouselClampModule(String aName,
                               int aTickMillis,
                               Sensor14bits filterPresenceSensor,
                               Sensor14bits lockSensor,
                               Thermometer thermometer,
                               int filterPositionValueA,
                               int filterPositionValueB,
                               int filterPositionValueC,
                               int filterPositionOffset,
                               int lockSensorValueA,
                               int lockSensorValueB,
                               int lockSensorValueC,
                               int lockSensorOffset,
                               int timeoutForUnlocking,
                               int timeoutForReleasing,
                               int currentToUnlock,
                               int currentToMaintainUnlocked)

Method Detail

getDummyFilter

public Filter getDummyFilter()

setDummyFilter

public void setDummyFilter(Filter dummyFilter)

updateTemperature

public double updateTemperature()

Description copied from class: CarouselClampModule

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

Overrides:

updateTemperature in class CarouselClampModule

Returns:

initModule

public void initModule()

Overrides:

initModule in class CarouselClampModule

startAction

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

Overrides:

startAction in class CarouselClampModule

Throws:

SDORequestException

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

updateStateWithSensors

public void updateStateWithSensors()
                            throws FcsHardwareException

Description copied from class: CarouselClampModule

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.

Overrides:

updateStateWithSensors in class CarouselClampModule

Throws:

FcsHardwareException