org.lsst.ccs.subsystems.fcs

Class AutochangerLatchModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

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

org.lsst.ccs.subsystems.fcs.AutochangerLatchModule

All Implemented Interfaces:

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

public class AutochangerLatchModule
extends MobileItemModule
implements FilterLatch

This class is a model for the latch which lock a filter on the autochanger trucks. The ACTION methods : open and close of this class is used in ENGINEERING mode only when an operator may need to open or close only one Latch. In NORMAL mode, when we have to open or close both Latches in the same time, the class AutochangerTwoLatches is used. On the autochanger there are 2 latches : one on each side of the filter : at X+ and X-.

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 boolean	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
AutochangerLatchModule(String moduleName, int aTickMillis, EPOSController latchController, long timeoutForClosing, long timeoutForOpening, NumericSensor lockSensor, NumericSensor unlockSensor, NumericSensor filterPresenceSensor, int minCurrent, int maxCurrent, int currentToOpen)

Method Summary

Modifier and Type	Method and Description
void	abortAction(FcsEnumerations.MobileItemAction action, long delay)
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware()
String	close()
String	getControllerName()
int	getCurrentToOpen()
NumericSensor	getFilterPresenceSensor()
EPOSController	getLatchController()
NumericSensor	getLockSensor()
FcsEnumerations.LockStatus	getLockStatus()
int	getMaxCurrent()
int	getMinCurrent()
StatusDataPublishedByAutochangerLatch	getStatusData()
long	getTimeoutForClosing()
long	getTimeoutForOpening()
NumericSensor	getUnlockSensor()
void	initModule()
boolean	isActionCompleted(FcsEnumerations.MobileItemAction action)
boolean	isControllerInFault()
boolean	isEmpty()
boolean	isHardwareReady()
boolean	isInError()
boolean	isInitialized()
boolean	isLocked()
boolean	isUnlocked()
String	open()
void	postAction(FcsEnumerations.MobileItemAction action)
void	processUpdate(Observable source, org.lsst.ccs.framework.Module.ValueUpdate v) What to do when the Modules we observe send there new values.
void	publishData() Publish Data on status bus for trending data base and GUIs.
void	quickStopAction(FcsEnumerations.MobileItemAction action, long delay)
void	setCurrentToOpen(int currentToOpen)
void	setMaxCurrent(int maxCurrent)
void	setMinCurrent(int minCurrent)
void	startAction(FcsEnumerations.MobileItemAction action)
void	tick()
void	updateCurrent() Updates the field readCurrent of the latch in reading the CPU of the controller.
void	updateStateWithSensors() This methods updates the whole autochanger state in reading all the sensors.
void	updateStateWithSensors(String[] hexaValues) This methods updates lockStatus from the values return by the sensors.
void	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, 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, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.subsystems.fcs.common.FilterLatch

getName

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

updatingState

protected volatile boolean updatingState

Constructor Detail

AutochangerLatchModule

public AutochangerLatchModule(String moduleName,
                              int aTickMillis,
                              EPOSController latchController,
                              long timeoutForClosing,
                              long timeoutForOpening,
                              NumericSensor lockSensor,
                              NumericSensor unlockSensor,
                              NumericSensor filterPresenceSensor,
                              int minCurrent,
                              int maxCurrent,
                              int currentToOpen)

Method Detail

getFilterPresenceSensor

public NumericSensor getFilterPresenceSensor()

Specified by:

getFilterPresenceSensor in interface FilterLatch

getLockSensor

public NumericSensor getLockSensor()

Specified by:

getLockSensor in interface FilterLatch

getUnlockSensor

public NumericSensor getUnlockSensor()

Specified by:

getUnlockSensor in interface FilterLatch

getControllerName

@Command(type=QUERY,
         level=1,
         description="Returns this latch controller name.")
public String getControllerName()

getLatchController

public EPOSController getLatchController()

isControllerInFault

@Command(type=QUERY,
         level=1,
         description="Returns true if latchController is in Fault.")
public boolean isControllerInFault()

Specified by:

isControllerInFault in interface FilterLatch

isInitialized

@Command(type=QUERY,
         level=1,
         description="Returns true if latch is initialized.")
public boolean isInitialized()

setMinCurrent

@ConfigChanger
public void setMinCurrent(int minCurrent)

setMaxCurrent

@ConfigChanger
public void setMaxCurrent(int maxCurrent)

setCurrentToOpen

@ConfigChanger
public void setCurrentToOpen(int currentToOpen)

getMinCurrent

public int getMinCurrent()

getMaxCurrent

public int getMaxCurrent()

getCurrentToOpen

public int getCurrentToOpen()

getTimeoutForOpening

public long getTimeoutForOpening()

getTimeoutForClosing

public long getTimeoutForClosing()

getLockStatus

public FcsEnumerations.LockStatus getLockStatus()

Specified by:

getLockStatus in interface FilterLatch

isLocked

@Command(type=QUERY,
         level=1,
         description="Returns true if LockStatus=LOCKED")
public boolean isLocked()

isUnlocked

@Command(type=QUERY,
         level=1,
         description="Returns true if LockStatus=UNLOCKED")
public boolean isUnlocked()

isInError

@Command(type=QUERY,
         level=1,
         description="Returns true if LockStatus=ERROR, this means that unlockSensor and lockSensor return non consistant values.")
public boolean isInError()

isEmpty

@Command(type=QUERY,
         level=1,
         description="Returns true if autochanger is empty.")
public boolean isEmpty()

initModule

public void initModule()

Overrides:

initModule in class MobileItemModule

tick

public void tick()

Overrides:

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

checkHardware

public org.lsst.ccs.framework.TreeWalkerDiag checkHardware()
                                                    throws org.lsst.ccs.HardwareException

Specified by:

checkHardware in interface org.lsst.ccs.framework.HardwareController

Overrides:

checkHardware in class MobileItemModule

Throws:

org.lsst.ccs.HardwareException

updateStateWithSensors

@Command(type=ACTION,
         level=1,
         description="Update latch state in reading sensors.")
public void updateStateWithSensors()
                                                                                                                                   throws FcsHardwareException

This methods updates the whole autochanger state in reading all the sensors.

Throws:

FcsHardwareException

updateStateWithSensors

@Command(type=ACTION,
         level=1,
         description="Update state in reading sensors.")
public void updateStateWithSensors(String[] hexaValues)

This methods updates lockStatus from the values return by the sensors. This values are given in an array of hexa values as arguments of the method.

Parameters:

hexaValues -

updateCurrent

@Command(type=QUERY,
         level=1,
         description="Update latch current in reading controller.")
public void updateCurrent()
                                                                                                                              throws org.lsst.ccs.messaging.BadCommandException,
                                                                                                                                     SDORequestException

Updates the field readCurrent of the latch in reading the CPU of the controller. This method is used in the simulator mainly.

Throws:

org.lsst.ccs.messaging.BadCommandException

SDORequestException

isHardwareReady

@Command(type=QUERY,
         level=1,
         description="Returns true if autochanger hardware is connected and ready.")
public boolean isHardwareReady()

Specified by:

isHardwareReady in class MobileItemModule

close

@Command(type=ACTION,
         level=1,
         description="Close latch.")
public String close()
                                                                                          throws org.lsst.ccs.messaging.BadCommandException,
                                                                                                 org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                                                                                 FcsHardwareException

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

open

@Command(type=ACTION,
         level=1,
         description="Open latch.")
public String open()
                                                                                        throws org.lsst.ccs.messaging.BadCommandException,
                                                                                               org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                                                                               FcsHardwareException

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

isActionCompleted

public boolean isActionCompleted(FcsEnumerations.MobileItemAction action)

Specified by:

isActionCompleted in class MobileItemModule

updateStateWithSensorsToCheckIfActionIsCompleted

public void updateStateWithSensorsToCheckIfActionIsCompleted()
                                                      throws Exception

Specified by:

updateStateWithSensorsToCheckIfActionIsCompleted in class MobileItemModule

Throws:

Exception

startAction

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

Specified by:

startAction in class MobileItemModule

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

abortAction

public void abortAction(FcsEnumerations.MobileItemAction action,
                        long delay)
                 throws org.lsst.ccs.messaging.BadCommandException,
                        org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                        FcsHardwareException

Specified by:

abortAction in class MobileItemModule

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

quickStopAction

public void quickStopAction(FcsEnumerations.MobileItemAction action,
                            long delay)
                     throws org.lsst.ccs.messaging.BadCommandException,
                            org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                            FcsHardwareException

Specified by:

quickStopAction in class MobileItemModule

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

postAction

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

Specified by:

postAction in class MobileItemModule

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

processUpdate

public void processUpdate(Observable source,
                          org.lsst.ccs.framework.Module.ValueUpdate v)

What to do when the Modules we observe send there new values. This class observes its controller to publish data when its controller is in fault or after a faultReset. Needed to update the GUI.

Overrides:

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

Parameters:

source -

v -

getStatusData

public StatusDataPublishedByAutochangerLatch getStatusData()

publishData

@Command(type=QUERY,
         level=1,
         description="Publish Data on the Status Bus.")
public void publishData()

Publish Data on status bus for trending data base and GUIs.

Specified by:

publishData in class MobileItemModule