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.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, FilterHolder, org.lsst.ccs.UsesSubsystem

public class LoaderModule
extends org.lsst.ccs.framework.Module
implements org.lsst.ccs.framework.HardwareController, FilterHolder

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

name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
LoaderModule(LoaderCarrierModule carrier, LoaderClampModule clamp, String plutoGatewayName, RedondantSensors filterPresenceSensors, RedondantSensors loaderOnCameraSensors) Build a LoaderModule with a carrier, a clamp and sensors.

Method Summary

Modifier and Type	Method and Description
void	checkConditionsForCarrierMotion() Checks if the loader carrier can move.
void	checkConditionsForOpeningHooks() Check if the clamp can be opened.
void	checkConditionsForUnclampingHooks()
void	checkConnectedOnCamera() Check if loader is connected on camera.
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware() Check that plutoGateway is booted and initialized.
void	checkLoaderNotEmpty() Check if the clamp can be closed.
void	checkStarted() CheckStarted is executed by completeInitialization when a first start has failed.
void	checkStopped() This method is executed during a shutdown of the subystem to prevent a shutdown when some hardware is moving.
StatusDataPublishedByLoader	createStatusDataPublishedByLoader() Creates an Object to be published on the STATUS bus.
LoaderCarrierModule	getCarrier() Returns carrier.
LoaderClampModule	getClamp() Returns clamp.
void	initModule()
boolean	isAtHandoff() This method returns true if the autochanger trucks are at HANDOFF position, false otherwise.
boolean	isAtStandby() This method returns true if the autochanger trucks are at STANDBY position, false otherwise.
boolean	isAutochangerHoldingFilter() Return true if the autochanger is holding the filter.
boolean	isConnectedOnCamera() Returns the boolean field atHandoff.
boolean	isEmpty() Returns the boolean field empty.
boolean	isHoldingFilter() Return true if a filter is present and it is held by the loader clamp.
boolean	isInitialized()
void	loadFilterInCamera() This command can be launched when a filter is in the loader and we want to put in inside the camera.
void	locateHardware() This command has to be executed after the initialization phase and after the checkHardware command.
String	printHardwareState() Print list of hardware with initialization information.
void	publishData() Publish Data on status bus for trending data base and GUIs.
void	unloadFilterFromCamera() This command can be launched when the loader is empty and we want to take a filter from the camera.
void	updateFCSStateToReady() Update FCS state and FCS readyness state and publish on the status bus.
void	updateStateAndCheckSensors()
void	updateStateWithSensors() This methods updates the carrier and clamp state in reading all the sensors.

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

getNObserverThreads, getObservables, getTickMillis, init, listens, processUpdate, setNObserverThreads, setObservables, setTickMillis, shutdownNow, 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.framework.Configurable

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

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

setParameterBulk

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

postInit, postShutdown, postStart, start

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

sendSignal, sendSignalWithTimeLimit, signal

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Constructor Detail

LoaderModule

public LoaderModule(LoaderCarrierModule carrier,
                    LoaderClampModule clamp,
                    String plutoGatewayName,
                    RedondantSensors filterPresenceSensors,
                    RedondantSensors loaderOnCameraSensors)

Build a LoaderModule with a carrier, a clamp and sensors.

Parameters:

carrier -

clamp -

plutoGatewayName -

filterPresenceSensors -

loaderOnCameraSensors -

Method Detail

getCarrier

public LoaderCarrierModule getCarrier()

Returns carrier.

Returns:

carrier

getClamp

public LoaderClampModule getClamp()

Returns clamp.

Returns:

initModule

public void initModule()

Overrides:

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

isInitialized

@Command(type=QUERY,
         level=0,
         description="Return true if hardware (controllers and plutoGateway) is correctly initializedand homing of the controllers is done.")
public boolean isInitialized()

Returns:

true if hardware (controllers and plutoGateway) is correctly initialized and checkHardwareStateAndDoHomingIfPossible of the controllers is done.

isEmpty

@Command(type=QUERY,
         level=0,
         description="Return true if there is no filter in the loader. This command doesn\'t read again the sensors.")
public boolean isEmpty()

Returns the boolean field empty. If the empty boolean is being updated and waits for a response from a sensor, this methods waits until empty is updated. If the field empty is not being updated, it returns immediatly the field empty.

Returns:

empty

isConnectedOnCamera

@Command(type=QUERY,
         level=0,
         description="Return true if the loader is connected on the camera. This command doesn\'t read again the sensors.")
public boolean isConnectedOnCamera()

Returns the boolean field atHandoff. If the atHandoff boolean is being updated and waits for a response from a sensor, this methods waits until atHandoff is updated. If the field atHandoff is not being updated, it returns immediatly the field atHandoff.

Returns:

atHandoff

isAutochangerHoldingFilter

@Command(type=QUERY,
         level=0,
         description="Return true if the autochanger is holding the filter. This command doesn\'t read again the sensors.")
public boolean isAutochangerHoldingFilter()

Return true if the autochanger is holding the filter. This command doesn't read again the sensors.

Returns:

Throws:

FcsHardwareException

isHoldingFilter

@Command(type=QUERY,
         level=0,
         description="Return true if a filter is present and it is held by the loader clamp.")
public boolean isHoldingFilter()

Return true if a filter is present and it is held by the loader clamp.

Specified by:

isHoldingFilter in interface FilterHolder

Returns:

Throws:

FcsHardwareException

locateHardware

@Command(type=ACTION,
         level=1,
         description="Attention ! this commands does the homing of the controllers and might move hardware. Initialize loader hardware.",
         alias="homing")
public void locateHardware()
                                                                                                                                                                                                                               throws org.lsst.ccs.HardwareException

This command has to be executed after the initialization phase and after the checkHardware command. It can't be automaticaly executed during initialization phase because it's not compliant with the CCS requirement which says that the initialization of the subsystem can't make move hardware.

Throws:

org.lsst.ccs.HardwareException

checkHardware

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

Check that plutoGateway is booted and initialized. Read sensors and update clamp's lockStatus. Read position sensors and update carrier position status. Check that controllers are booted and not in fault.

Specified by:

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

Returns:

Throws:

org.lsst.ccs.HardwareException

checkStarted

public void checkStarted()
                  throws org.lsst.ccs.HardwareException

CheckStarted is executed by completeInitialization when a first start has failed. Because end user could have changed many things, we have to check again that all is correct.

Specified by:

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

Throws:

org.lsst.ccs.HardwareException

checkStopped

public void checkStopped()
                  throws org.lsst.ccs.HardwareException

This method is executed during a shutdown of the subystem to prevent a shutdown when some hardware is moving. Nothing to do here because all the moving hardware of the loader is represented by the class MobilItemModule where the method checkStopped is implemented.

Specified by:

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

Throws:

org.lsst.ccs.HardwareException

checkConnectedOnCamera

public void checkConnectedOnCamera()

Check if loader is connected on camera.

Throws:

RejectedCommandException - if not connected on camera

checkConditionsForCarrierMotion

@Command(type=QUERY,
         level=1,
         description="Check if the carrier can move.")
public void checkConditionsForCarrierMotion()

Checks if the loader carrier can move.

Throws:

FcsHardwareException

FailedCommandException

checkConditionsForOpeningHooks

@Command(type=QUERY,
         level=1,
         description="Check if the clamp can be opened.")
public void checkConditionsForOpeningHooks()

Check if the clamp can be opened.

Throws:

FcsHardwareException

checkConditionsForUnclampingHooks

public void checkConditionsForUnclampingHooks()

checkLoaderNotEmpty

@Command(type=QUERY,
         level=1,
         description="Check if the clamp can be closed.")
public void checkLoaderNotEmpty()

Check if the clamp can be closed. Clamp can be close if sensors are not in error and a filter is in the loader.

Throws:

FcsHardwareException

updateStateAndCheckSensors

public void updateStateAndCheckSensors()

updateStateWithSensors

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

This methods updates the carrier and clamp state in reading all the sensors.

Specified by:

updateStateWithSensors in interface FilterHolder

Throws:

FcsHardwareException

updateFCSStateToReady

@Command(type=ACTION,
         level=1,
         description="Update FCS state and FCS readyness state and publishes on the status bus.")
public void updateFCSStateToReady()

Update FCS state and FCS readyness state and publish on the status bus. Check that Loader hardware is ready to be operated and moved. This means that : - all CAN open devices are booted, identified and initialized, - checkHardwareStateAndDoHomingIfPossible has been done on the controllers.

loadFilterInCamera

@Command(type=ACTION,
         level=1,
         description="Load a filter from the loader into the camera.")
public void loadFilterInCamera()

This command can be launched when a filter is in the loader and we want to put in inside the camera.

Throws:

RejectedCommandException

FcsHardwareException

FailedCommandException

unloadFilterFromCamera

@Command(type=ACTION,
         level=1,
         description="Unload a filter from the camera into the loader.")
public void unloadFilterFromCamera()

This command can be launched when the loader is empty and we want to take a filter from the camera. A filter must be at handoff position and held by autochanger.

Throws:

RejectedCommandException

FcsHardwareException

SDORequestException

FailedCommandException

createStatusDataPublishedByLoader

public StatusDataPublishedByLoader createStatusDataPublishedByLoader()

Creates an Object to be published on the STATUS bus.

Returns:

publishData

public void publishData()

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

isAtHandoff

public boolean isAtHandoff()

Description copied from interface: FilterHolder

This method returns true if the autochanger trucks are at HANDOFF position, false otherwise.

Specified by:

isAtHandoff in interface FilterHolder

Returns:

isAtStandby

public boolean isAtStandby()

Description copied from interface: FilterHolder

This method returns true if the autochanger trucks are at STANDBY position, false otherwise.

Specified by:

isAtStandby in interface FilterHolder

Returns:

printHardwareState

@Command(type=QUERY,
         level=1,
         description="Print list of hardware with initialization information.")
public String printHardwareState()

Print list of hardware with initialization information.

Returns: