org.lsst.ccs.subsystems.fcs

Class LoaderModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.LoaderModule

All Implemented Interfaces:

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

public class LoaderModule
extends org.lsst.ccs.framework.Module

This is the model for the loader in the Filter Exchange System. The loader is used to load a filter into the camera or to unload a filter from the camera.

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 inherited from class org.lsst.ccs.framework.Module

environment, log, name, nObserverThreads, registry, tickMillis

Constructor Summary

Constructors

Constructor and Description
LoaderModule(String moduleName, int aTickMillis, LoaderCarrierModule carrier, LoaderClampModule clamp, NumericSensor filterPresenceSensor, NumericSensor loaderOnCameraPresenceSensor)

Method Summary

Methods

Modifier and Type	Method and Description
String	clampHooks() This method closes the clamps strongly.
String	closeHooks() This method closes the clamps.
LoaderCarrierModule	getCarrier()
LoaderClampModule	getClamp()
void	initializeHardware()
void	initModule()
boolean	isCarrierAtStoragePosition()
boolean	isEmpty()
boolean	isHoldingAFilter()
boolean	isMoving()
String	listHooks()
String	listSensorsValues()
void	moveToHandoff() Moves the loader carrier to the handoff position.
void	moveToStorage() Moves the loader carrier to the storage position.
String	openHooks() This method opens the clamp.
void	test()
void	tick()
void	updateCarrierStateWithSensors()
void	updateStateWithSensors() This updates the clamps state of the loader : clampsLockStatus

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

alias, change, checkHardware, dropConfigurationContext, getCheckedValueFromConfiguration, getChildren, getComponentByName, getComponentDictionariesTree, getComponentTree, getContext, getDictionary, getEnvironment, getMainDictionary, getModule, getName, getNObserverThreads, getObservables, getParent, getSubsystem, getTickMillis, init, listens, newConfigurationContext, notifyChange, notifyChangeWithoutPreliminaryChecks, percolateSignal, processUpdate, publish, publish, publish, publish, publish, publish, publishData, publishData, publishData, publishData, publishData, publishData, publishData, register, sendSignal, sendSignal, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, setTickMillis, shutdownCommand, shutdownNow, signal, start, 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

Constructor Detail

LoaderModule

@ConstructorProperties(value={"name","tickmillis","carrier","clamp","filterPresenceSensor","loaderOnCameraPresenceSensor"})
public LoaderModule(String moduleName,
                                       int aTickMillis,
                                       LoaderCarrierModule carrier,
                                       LoaderClampModule clamp,
                                       NumericSensor filterPresenceSensor,
                                       NumericSensor loaderOnCameraPresenceSensor)

Method Detail

isEmpty

@Command(type=QUERY,
         level=0,
         description="Return true if no filter is in the loader.")
public boolean isEmpty()

isMoving

@Command(type=QUERY,
         level=0,
         description="Return true if no filter is in the loader.")
public boolean isMoving()

isHoldingAFilter

@Command(type=QUERY,
         level=0,
         description="A filter is there and it is held by the clamp.")
public boolean isHoldingAFilter()

getClamp

public LoaderClampModule getClamp()

getCarrier

public LoaderCarrierModule getCarrier()

isCarrierAtStoragePosition

public boolean isCarrierAtStoragePosition()

initModule

public void initModule()

Overrides:

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

initializeHardware

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

Throws:

HardwareException

org.lsst.ccs.bus.ErrorInCommandExecutionException

org.lsst.ccs.bus.BadCommandException

tick

public void tick()

Overrides:

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

updateStateWithSensors

@Command(type=ACTION,
         level=0,
         description="Update clamp and carrier states in reading the sensors.")
public void updateStateWithSensors()
                            throws HardwareException,
                                   org.lsst.ccs.bus.ErrorInCommandExecutionException

This updates the clamps state of the loader : clampsLockStatus

Throws:

HardwareException

org.lsst.ccs.bus.ErrorInCommandExecutionException

closeHooks

@Command(type=ACTION,
         level=1,
         description="Close hooks.")
public String closeHooks()
                  throws org.lsst.ccs.bus.BadCommandException,
                         org.lsst.ccs.bus.ErrorInCommandExecutionException,
                         HardwareException

This method closes the clamps. When this action is completed the filter is clamped softly on the loader and can't fall.

Returns:

a message for the end user.

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException

clampHooks

@Command(type=ACTION,
         level=1,
         description="Clamp hooks.")
public String clampHooks()
                  throws org.lsst.ccs.bus.BadCommandException,
                         org.lsst.ccs.bus.ErrorInCommandExecutionException,
                         HardwareException

This method closes the clamps strongly. When this action is completed, the filter is clamped softly on the loader and is tight fermely on the carrier.

Returns:

a message for the end user.

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException

openHooks

@Command(level=1,
         description="Open the hooks",
         type=ACTION)
public String openHooks()
                 throws org.lsst.ccs.bus.BadCommandException,
                        org.lsst.ccs.bus.ErrorInCommandExecutionException,
                        HardwareException

This method opens the clamp.

Returns:

a message for the end user.

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException

moveToHandoff

@Command(level=1,
         description="Move the loader carrier to HANDOFF position",
         type=ACTION)
public void moveToHandoff()

Moves the loader carrier to the handoff position.

moveToStorage

@Command(type=ACTION,
         level=1,
         description="Move the loader carrier to STORAGE position")
public void moveToStorage()

Moves the loader carrier to the storage position.

updateCarrierStateWithSensors

@Command(type=ACTION,
         level=0,
         description="Update carrier states in reading the sensors.")
public void updateCarrierStateWithSensors()

listHooks

@Command(type=QUERY,
         level=0,
         description="List and display info on the hooks.")
public String listHooks()

listSensorsValues

@Command(type=QUERY,
         level=1,
         description="List and display hooks sensors values.")
public String listSensorsValues()

test

public void test()