org.lsst.ccs.subsystems.fcs.singlefiltertest

Class SftMainModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.MainModule

org.lsst.ccs.subsystems.fcs.singlefiltertest.SftMainModule

All Implemented Interfaces:

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

public class SftMainModule
extends MainModule
implements AutochangerHandler

The Main Module for the single-filter-test. It raises an alert : - FCS006 in start.

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.subsystems.fcs.MainModule

bridge, haltRequired, hardwareReady, stopRequired

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

environment, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
SftMainModule(String aName, int aTickMillis, BridgeToHardware bridge, Filter dummyFilter)

Method Summary

Modifier and Type	Method and Description
void	checkPreConditionsForUnlockClamps()
String	displayData()
String	executeSequence1() This method is the main sequence of commands that we want to test on the Single Filter Test.
String	executeSequence1(int nb) This method will execute nb times the Sequence1 : the parameter nb is given by the user at the console.
SftAutoChangerModule	getAutoChangerModule()
SftCarouselModule	getCarouselModule()
Filter	getDummyFilter()
Filter	getFilterAtStandby()
String	goToInitialState() Initial state for sequence1 : autochanger is in highposition and trucks are empty carousel holds a filter and its clamps are in CLAMPEDONFILTER state.
void	initModule()
boolean	isAutochangerHoldingFilterAtSTANDBY() ***********************************************************************************************
void	locateFilter()
void	start()
String	toString()
void	updateStateWithSensors() This command updates the state of the carousel and of the autochanger in reading the sensors.

Methods inherited from class org.lsst.ccs.subsystems.fcs.MainModule

controlRealHardware, getFilterNames, getHaltRequired, getStopRequired, getTcpProxy, isHardwareReady, listHardware, listHardwareNames, postStart, signal, simulateAlert, simulateWarning

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

getComponentTree, getEnvironment, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, processUpdate, sendSignal, sendSignalWithTimeLimit, setEnvironment, setName, 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, wait, wait, wait

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

change, getCheckedValueFromConfiguration, getChildren, getComponentByName, getFullPath, getParent, getParentObject, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, setBulkParameter, submitChange, submitChanges, validateBulkChange

Constructor Detail

SftMainModule

public SftMainModule(String aName,
                     int aTickMillis,
                     BridgeToHardware bridge,
                     Filter dummyFilter)

Method Detail

getDummyFilter

public Filter getDummyFilter()

Returns:

the dummyFilter

isAutochangerHoldingFilterAtSTANDBY

public boolean isAutochangerHoldingFilterAtSTANDBY()

***********************************************************************************************

Specified by:

isAutochangerHoldingFilterAtSTANDBY in interface AutochangerHandler

Returns:

initModule

public void initModule()

Overrides:

initModule in class MainModule

start

public void start()

Specified by:

start in interface org.lsst.ccs.framework.Configurable

locateFilter

@Command(level=0,
         description="Read the sensors and update location of the filter and state of Carousel and Autochanger.",
         type=QUERY)
public void locateFilter()
                                                                                                                                                                           throws FcsHardwareException,
                                                                                                                                                                                  org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                                                                                                                                                                  org.lsst.ccs.messaging.BadCommandException

Throws:

FcsHardwareException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

org.lsst.ccs.messaging.BadCommandException

checkPreConditionsForUnlockClamps

@Command(level=1,
         description="Check if the carousel is ready to unlock the clamps in a safe way for the filter.",
         type=QUERY,
         alias="checkUnlock")
public void checkPreConditionsForUnlockClamps()
                                                                                                                                                                                                                      throws FcsHardwareException,
                                                                                                                                                                                                                             org.lsst.ccs.messaging.BadCommandException,
                                                                                                                                                                                                                             org.lsst.ccs.messaging.ErrorInCommandExecutionException

Throws:

FcsHardwareException

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

displayData

@Command(level=1,
         description="To display at a console the status of the hardware.",
         type=QUERY)
public String displayData()

goToInitialState

@Command(level=1,
         description="Move the hardware to the initial state : ",
         type=ACTION)
public String goToInitialState()
                                                                                                                                  throws FcsHardwareException,
                                                                                                                                         org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                                                                                                                         org.lsst.ccs.messaging.BadCommandException

Initial state for sequence1 : autochanger is in highposition and trucks are empty carousel holds a filter and its clamps are in CLAMPEDONFILTER state.

Returns:

Throws:

FcsHardwareException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

org.lsst.ccs.messaging.BadCommandException

executeSequence1

@Command(level=0,
         description="The world famous sequence 1",
         type=ACTION,
         alias="es1")
public String executeSequence1()
                                                                                                                                          throws org.lsst.ccs.messaging.BadCommandException,
                                                                                                                                                 org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                                                                                                                                 FcsHardwareException,
                                                                                                                                                 CanOpenException

This method is the main sequence of commands that we want to test on the Single Filter Test. It executes this sequence of commands once. From the initial position (autochanger trucks empty in the higher position) :

• the autochanger trucks go down along the rails to standby position,
• the autochanger grabs the filter at standby position,
• the carousel ungrabs the filter at standby position,
• the autochanger moves the filter to the higher position,
• the carousel releases the clamps to be ready to clamp a filter again,
• the autochanger moves back the filter at standby position,
• the carousel checks if the filter is clamped at standby position,
• the autochanger ReleaseBrakes the filter latches,
• the autochanger trucks go empty to the higher position.

Returns:

a message for the operator

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

CanOpenException

executeSequence1

@Command(level=0,
         description="The world famous sequence 1 (with number of repetitions)",
         type=ACTION,
         alias="es1")
public String executeSequence1(@Argument(name="nExecutions",description="Number of executions")
                                                                                                                                                                              int nb)
                                                                                                                                                                       throws org.lsst.ccs.messaging.BadCommandException,
                                                                                                                                                                              org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                                                                                                                                                              FcsHardwareException,
                                                                                                                                                                              CanOpenException

This method will execute nb times the Sequence1 : the parameter nb is given by the user at the console.

Parameters:

nb - : number of times we want to execute the Sequence1

Returns:

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

CanOpenException

getFilterAtStandby

public Filter getFilterAtStandby()

toString

public String toString()

Overrides:

toString in class MainModule

updateStateWithSensors

@Command(level=1,
         description="Read the sensors and update the state of the carousel and the autochanger.",
         type=QUERY)
public void updateStateWithSensors()
                                                                                                                                                                      throws FcsHardwareException,
                                                                                                                                                                             org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                                                                                                                                                             org.lsst.ccs.messaging.BadCommandException

This command updates the state of the carousel and of the autochanger in reading the sensors. It has to be used in Engineering mode at the console when we send commands step by step.

Overrides:

updateStateWithSensors in class MainModule

Throws:

FcsHardwareException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

org.lsst.ccs.messaging.BadCommandException

getCarouselModule

public SftCarouselModule getCarouselModule()

getAutoChangerModule

public SftAutoChangerModule getAutoChangerModule()