org.lsst.ccs.subsystems.fcs.singlefiltertest

Class SftFilterLatchModule

java.lang.Object

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

org.lsst.ccs.subsystems.fcs.singlefiltertest.SftFilterLatchModule

All Implemented Interfaces:

org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, AlertRaiser, org.lsst.ccs.UsesSubsystem

public class SftFilterLatchModule
extends MobileItemModule

This is a model for a latch. A latch is what holds a filter in the trucks of the autochanger. There is 2 latches : one on each side of the filter. The state of the latches are monitoring by digital sensors : one sensor to know if a filter is in the latch or not and 2 status sensors to know if the latch is EngageBrakeed or ReleaseBrakeed. If the 2 status sensors are inconsistent, the latch is in error. This class is used in single-filter-test. For the final product the class AutochangerLatchModule is used.

Author:

virieux

Field Summary

Fields

Modifier and Type	Field and Description
protected DigitalSensor	filterPresenceSensor
protected LatchActuatorModule	latchActuator
protected DigitalSensor	lockSensor
protected DigitalSensor	unlockSensor
protected boolean	updatingState This is used when we update the latch state with the values returned by the sensors.

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

currentAction, FCSLOG, hasToWaitForEndOfAction, lock, name, scheduler

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

alertSeparater

Constructor Summary

Constructors

Constructor and Description
SftFilterLatchModule(CompactIOModule filterSensorsDIO, DigitalSensor lockSensor, DigitalSensor unlockSensor, DigitalSensor filterPresenceSensor, LatchActuatorModule latchActuator) Build a new SftFilterLatchModule

Method Summary

Modifier and Type	Method and Description
void	abortAction(FcsEnumerations.MobileItemAction action, long delay) aborts action actually running.
String	close() Close the latch : turn on the actuator, read the sensors and wait until the latch is closed.
StatusDataPublishedByAutochangerLatch	createStatusDataPublishedByLatch() This methods is used in the single-filter-test.
DigitalSensor	getFilterPresenceSensor()
LatchActuatorModule	getLatchActuator()
DigitalSensor	getLockSensor()
FcsEnumerations.LockStatus	getLockStatus()
FcsEnumerations.FilterPresenceStatus	getPresenceStatus() Return the filter presence status.
long	getTimeoutForClosing()
long	getTimeoutForOpening()
DigitalSensor	getUnlockSensor()
boolean	isActionCompleted(FcsEnumerations.MobileItemAction action)
boolean	isControllerInFault()
boolean	isLocked()
boolean	myDevicesReady() Returns true if hardware is connected and ready.
String	open() Open the latch if the carousel is holding the filter.
void	postAction(FcsEnumerations.MobileItemAction action)
void	publishData() Publish Data on status bus for trending data base and GUIs.
void	quickStopAction(FcsEnumerations.MobileItemAction action, long delay)
void	setLockStatus(FcsEnumerations.LockStatus lockStatus)
void	startAction(FcsEnumerations.MobileItemAction action) starts the action given as argument.
String	toString()
void	updateState(int hexaValue) Update Latch State.
void	updateStateWithSensors() Reads latch sensors and updates latch state.
void	updateStateWithSensorsToCheckIfActionIsCompleted() reads sensors or any device and updates state from sensors it can be also reading a position or a current on a motor controller.

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

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

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.HardwareController

checkHardware, checkStarted

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

raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseWarning, raiseWarning, raiseWarning, raiseWarning, raiseWarning

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

sendSignal, sendSignalWithTimeLimit

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

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

init, postInit, postShutdown, postStart, start

Field Detail

latchActuator

protected final LatchActuatorModule latchActuator

filterPresenceSensor

protected DigitalSensor filterPresenceSensor

lockSensor

protected DigitalSensor lockSensor

unlockSensor

protected DigitalSensor unlockSensor

updatingState

protected volatile boolean updatingState

This is used when we update the latch state with the values returned by the sensors.

Constructor Detail

SftFilterLatchModule

public SftFilterLatchModule(CompactIOModule filterSensorsDIO,
                            DigitalSensor lockSensor,
                            DigitalSensor unlockSensor,
                            DigitalSensor filterPresenceSensor,
                            LatchActuatorModule latchActuator)

Build a new SftFilterLatchModule

Parameters:

filterSensorsDIO -

lockSensor -

unlockSensor -

filterPresenceSensor -

latchActuator -

Method Detail

getTimeoutForClosing

public long getTimeoutForClosing()

getTimeoutForOpening

public long getTimeoutForOpening()

getFilterPresenceSensor

public DigitalSensor getFilterPresenceSensor()

getLatchActuator

public LatchActuatorModule getLatchActuator()

getLockSensor

public DigitalSensor getLockSensor()

getUnlockSensor

public DigitalSensor getUnlockSensor()

isControllerInFault

public boolean isControllerInFault()

myDevicesReady

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

Returns true if hardware is connected and ready.

Specified by:

myDevicesReady in class MobileItemModule

Returns:

isActionCompleted

public boolean isActionCompleted(FcsEnumerations.MobileItemAction action)

Specified by:

isActionCompleted in class MobileItemModule

updateStateWithSensorsToCheckIfActionIsCompleted

public void updateStateWithSensorsToCheckIfActionIsCompleted()

Description copied from class: MobileItemModule

reads sensors or any device and updates state from sensors it can be also reading a position or a current on a motor controller. It's abstract because it'up to the sub-classes to know what to do.

Specified by:

updateStateWithSensorsToCheckIfActionIsCompleted in class MobileItemModule

updateStateWithSensors

@Command(type=QUERY,
         level=1,
         description="Reads latch sensors and updates latch state")
public void updateStateWithSensors()

Reads latch sensors and updates latch state.

Throws:

FcsHardwareException

startAction

public void startAction(FcsEnumerations.MobileItemAction action)
                 throws FcsHardwareException

Description copied from class: MobileItemModule

starts the action given as argument. It has to be specified in sub-classes. Usually it consist in sending a command to a controller : give a value of current or give a target position.

Specified by:

startAction in class MobileItemModule

Throws:

FcsHardwareException

abortAction

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

Description copied from class: MobileItemModule

aborts action actually running. It has to be specified in sub-classes. It can be : write a zero value of current or send a stop command to a controller.

Specified by:

abortAction in class MobileItemModule

postAction

public void postAction(FcsEnumerations.MobileItemAction action)

Specified by:

postAction in class MobileItemModule

getLockStatus

public FcsEnumerations.LockStatus getLockStatus()

setLockStatus

public void setLockStatus(FcsEnumerations.LockStatus lockStatus)

getPresenceStatus

public FcsEnumerations.FilterPresenceStatus getPresenceStatus()

Return the filter presence status. Wait if the state is beeing updated.

Returns:

open

@Command(type=ACTION,
         level=3,
         description="Open latch")
public String open()

Open the latch if the carousel is holding the filter.

Returns:

Throws:

RejectedCommandException

FcsHardwareException

close

@Command(type=ACTION,
         level=3,
         description="Close latch")
public String close()

Close the latch : turn on the actuator, read the sensors and wait until the latch is closed. If the latch is not closed during the delai : timeoutForClosing throws an Exception.

Returns:

Throws:

FcsHardwareException

isLocked

@Command(type=QUERY,
         level=1,
         description="Return true if the latch is closed")
public boolean isLocked()

Returns:

true if the latch is closed.

updateState

public void updateState(int hexaValue)

Update Latch State.

Parameters:

hexaValue -

createStatusDataPublishedByLatch

public StatusDataPublishedByAutochangerLatch createStatusDataPublishedByLatch()

This methods is used in the single-filter-test.

Returns:

publishData

public void publishData()

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

Specified by:

publishData in class MobileItemModule

toString

public String toString()

Overrides:

toString in class Object

quickStopAction

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

Specified by:

quickStopAction in class MobileItemModule