org.lsst.ccs.subsystems.fcs

Class AutochangerThreeOnlineClamps

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

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

org.lsst.ccs.subsystems.fcs.AutochangerThreeOnlineClamps

All Implemented Interfaces:

Observer, org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, AlertRaiser, org.lsst.ccs.UsesSubsystem

public class AutochangerThreeOnlineClamps
extends MobileItemModule

The Three Online clamps which holds a filter when it is at ONLINE position can ve viewed as a single object. It's the goal of this class to represent this object. Opening or closing the 3 clamps at ONLINE is not the same action as opening or closing online clamps one by one.

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

name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
AutochangerThreeOnlineClamps(AutochangerOnlineClampModule onlineClampXminus, AutochangerOnlineClampModule onlineClampXplus, AutochangerOnlineClampModule onlineClampY) Create a AutochangerThreeOnlineClamps with 3 AutochangerOnlineClampModule.

Method Summary

Modifier and Type	Method and Description
void	abortAction(FcsEnumerations.MobileItemAction action, long delay)
StatusDataPublishedByAutochangerThreeClamps	createStatusDataPublishedByThreeClamps()
FcsEnumerations.LockStatus	getLockStatus() Return lockStatus If lockStatus is being updated, wait until update completion else return immediately lockStatus.
StatusDataPublishedByAutochangerThreeClamps	getStatusData()
void	initModule()
boolean	isActionCompleted(FcsEnumerations.MobileItemAction action)
boolean	isCANDevicesReady() Return true if the 3 onlineClamps hardware is ready.
boolean	isInError() Returns true if LockStatus=ERROR
boolean	isInitialized() Return true if the 3 onlineClamps hardware is initialized.
boolean	isLocked() Returns true if LockStatus=LOCKED
boolean	isUnlocked() Returns true if LockStatus=UNLOCKED
String	lockClamps() Lock the online clamps.
void	postAction(FcsEnumerations.MobileItemAction action)
void	publishData()
void	quickStopAction(FcsEnumerations.MobileItemAction action, long delay)
void	startAction(FcsEnumerations.MobileItemAction action)
String	unlockClamps() Unlock the online clamps.
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, checkHardware, checkStarted, checkStopped, executeAction, getHaltRequired, isMoving, quickstop, readSensorsUntilActionIsCompleted, shutdownNow, signal, stop, stop

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

getNObserverThreads, getObservables, getTickMillis, init, listens, processUpdate, sendSignal, sendSignalWithTimeLimit, setNObserverThreads, setObservables, setTickMillis, 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, toString, wait, wait, wait

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

raiseAlarm, raiseAlarm, raiseAlarm, raiseWarning, raiseWarning, raiseWarning

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

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

change, dropSubmittedChanges, getChildren, getComponentByName, getEnvironment, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, postStart, printConfigurableParameters, setBulkParameter, start, submitChange, submitChanges, validateBulkChange

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

Field Detail

updatingState

protected volatile boolean updatingState

Constructor Detail

AutochangerThreeOnlineClamps

public AutochangerThreeOnlineClamps(AutochangerOnlineClampModule onlineClampXminus,
                                    AutochangerOnlineClampModule onlineClampXplus,
                                    AutochangerOnlineClampModule onlineClampY)

Create a AutochangerThreeOnlineClamps with 3 AutochangerOnlineClampModule.

Parameters:

onlineClampXminus -

onlineClampXplus -

onlineClampY -

Method Detail

getLockStatus

public FcsEnumerations.LockStatus getLockStatus()

Return lockStatus If lockStatus is being updated, wait until update completion else return immediately lockStatus.

Returns:

isLocked

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

Returns true if LockStatus=LOCKED

Returns:

isUnlocked

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

Returns true if LockStatus=UNLOCKED

Returns:

isInError

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

Returns true if LockStatus=ERROR

Returns:

initModule

public void initModule()

Overrides:

initModule in class MobileItemModule

isInitialized

@Command(type=QUERY,
         level=0,
         description="Return true if the 3 onlineClamps hardware is ready : controllers ready, controllers parameters checked and controllers configured.")
public boolean isInitialized()

Return true if the 3 onlineClamps hardware is initialized.

Returns:

lockClamps

@Command(type=ACTION,
         level=0,
         description="Lock the online clamps.")
public String lockClamps()

Lock the online clamps.

Returns:

Throws:

FcsHardwareException

unlockClamps

@Command(type=ACTION,
         level=0,
         description="Unlock the online clamps.")
public String unlockClamps()

Unlock the online clamps.

Returns:

Throws:

FcsHardwareException

isCANDevicesReady

@Command(type=QUERY,
         level=0,
         description="Return true if the 3 onlineClamps hardware is ready.")
public boolean isCANDevicesReady()

Return true if the 3 onlineClamps hardware is ready.

Specified by:

isCANDevicesReady in class MobileItemModule

Returns:

isActionCompleted

public boolean isActionCompleted(FcsEnumerations.MobileItemAction action)

Specified by:

isActionCompleted in class MobileItemModule

updateStateWithSensorsToCheckIfActionIsCompleted

public void updateStateWithSensorsToCheckIfActionIsCompleted()

Specified by:

updateStateWithSensorsToCheckIfActionIsCompleted in class MobileItemModule

startAction

public void startAction(FcsEnumerations.MobileItemAction action)

Specified by:

startAction in class MobileItemModule

abortAction

public void abortAction(FcsEnumerations.MobileItemAction action,
                        long delay)

Specified by:

abortAction in class MobileItemModule

quickStopAction

public void quickStopAction(FcsEnumerations.MobileItemAction action,
                            long delay)

Specified by:

quickStopAction in class MobileItemModule

postAction

public void postAction(FcsEnumerations.MobileItemAction action)

Specified by:

postAction in class MobileItemModule

getStatusData

public StatusDataPublishedByAutochangerThreeClamps getStatusData()

createStatusDataPublishedByThreeClamps

public StatusDataPublishedByAutochangerThreeClamps createStatusDataPublishedByThreeClamps()

publishData

public void publishData()

Specified by:

publishData in class MobileItemModule

updateStateWithSensors

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

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 -