org.lsst.ccs.subsystems.fcs

Class FcsMainModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.MainModule

org.lsst.ccs.subsystems.fcs.FcsMainModule

All Implemented Interfaces:

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

public class FcsMainModule
extends MainModule

The main module in FCS. Commands can be sent to the FcsMainModule from the CCS Master Control Module (MCM) in normal operation mode or from a Console (org.lsst.ccs.subsystem.console.TestConsole).

Example of commands that can be sent to the FcsMainModule :
Console> invoke fcs-test MoveFilterToOnline filtername

The main goals of the FcsMainModule is :

• Receive commands from MCM for the whole subsystem.
• Execute commands received from MCM in invoking methods on the carousel Module and on the autochanger Module.
• Handle the logic of the whole subsystem.
• Publish on the status bus the status of the whole subsystem.

Author:

virieux

See Also:

Serialized Form

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, hardwareReady

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

environment, log, name, nObserverThreads, registry, tickMillis

Constructor Summary

Constructors

Constructor and Description
FcsMainModule(String aName, int aTickMillis, BridgeToHardware bridge)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	controlFilterName(Object o) This method controls if the filter name given at the console by an operator is correct.
String	displayData() This method can be invoked from the Console to display at the Console status data of the whole subsystem.
Filter	getFilterAtStandby()
Filter	getFilterByName(String filterName)
protected Filter	getFilterOnline()
Map<String,Filter>	getFilters()
Double	getStandbyPosition()
void	initModule() In the initialisation, we want to do some software initialization, and some hardware initialization.
boolean	isEmptyOnline()
boolean	isEmptyStandBy()
void	loadFilter(Filter aFilter) Load a filter from the loader to the camera.
String	moveFilterToOnline(Object filterName) Move a filter to online position.
String	moveFilterToStandby(Object filterName) Move a filter to standby position.
String	printFilters()
void	processUpdate(Observable source, org.lsst.ccs.framework.Module.ValueUpdate v) What to do when the Modules we observe (carousel and autochanger) update their data to publish : we publish on status bus.
void	setFilters(Map<String,Filter> filters)
void	setStandbyPosition(Double standbyPosition)
String	stop(String moduleName) This method stops the FCS subsystem given as an argument.
String	toString()
void	unloadFilter(Filter aFilter) Unload a filter from the camera to the loader

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

isHardwareReady, listHardware

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

alias, change, checkHardware, dropConfigurationContext, getCheckedValueFromConfiguration, getChildren, getContext, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, newConfigurationContext, notifyChange, notifyChangeWithoutPreliminaryChecks, publishData, publishData, publishData, publishData, publishData, publishData, publishData, register, removeLogPanicState, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setHandlerLevel, setLogLevel, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, setTickMillis, shutdownCommand, shutdownNow, start, 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

Constructor Detail

FcsMainModule

public FcsMainModule(String aName,
             int aTickMillis,
             BridgeToHardware bridge)

Method Detail

initModule

public void initModule()

In the initialisation, we want to do some software initialization, and some hardware initialization. We publish the initial data for each piece of hardware : carousel and autochanger.

Overrides:

initModule in class MainModule

processUpdate

public void processUpdate(Observable source,
                 org.lsst.ccs.framework.Module.ValueUpdate v)

What to do when the Modules we observe (carousel and autochanger) update their data to publish : we publish on status bus.

Overrides:

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

printFilters

public String printFilters()

displayData

public String displayData()

This method can be invoked from the Console to display at the Console status data of the whole subsystem.

Returns:

toString

public String toString()

Overrides:

toString in class MainModule

stop

public String stop(String moduleName)
            throws IllegalArgumentException

This method stops the FCS subsystem given as an argument.

Parameters:

moduleName - cannot be null / must be : carousel, autochanger or fliprail

Throws:

IllegalArgumentException

moveFilterToOnline

public String moveFilterToOnline(Object filterName)
                          throws InterruptedException,
                                 IllegalArgumentException,
                                 org.lsst.ccs.bus.BadCommandException,
                                 org.lsst.ccs.bus.ErrorInCommandExecutionException,
                                 HardwareException,
                                 CanOpenException

Move a filter to online position. The filter must be in the camera. It can be on the carousel or on the autochanger. This method can be called by the end-user at the console.

Parameters:

filterName - name of the filter to move

Returns:

message for the user

Throws:

InterruptedException, - IllegalArgumentException

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

InterruptedException

IllegalArgumentException

HardwareException

CanOpenException

moveFilterToStandby

public String moveFilterToStandby(Object filterName)
                           throws InterruptedException,
                                  IllegalArgumentException,
                                  org.lsst.ccs.bus.BadCommandException,
                                  org.lsst.ccs.bus.ErrorInCommandExecutionException

Move a filter to standby position. The filter must be in the camera. The filter can be on carousel or on autochanger. This method can be called by the end-user at the console.

Parameters:

filterName - name of the filter to move

Returns:

message for the user

Throws:

InterruptedException, - IllegalArgumentException

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

InterruptedException

IllegalArgumentException

getFilterAtStandby

public Filter getFilterAtStandby()

controlFilterName

protected void controlFilterName(Object o)
                          throws IllegalArgumentException

This method controls if the filter name given at the console by an operator is correct.

Parameters:

o - the object we receive from the command line at the Console.

Throws:

IllegalArgumentException - in this case :

• the name is not a String,
• the name is unknown in the map filters,
• the name is known in the map filters, but the filter location is unknown,
• the name is known in the map filters, but the filter is out of the camera.

getFilterByName

public Filter getFilterByName(String filterName)

isEmptyStandBy

public boolean isEmptyStandBy()

Returns:

true if the socket at standby position on the carousel is empty (contains no filter)

isEmptyOnline

public boolean isEmptyOnline()

Returns:

true if there is no filter at online position. This can be because :

• the autochanger truck is not at online position.
• or the autochanger truck is at online position but it's empty.

getFilterOnline

protected Filter getFilterOnline()

getFilters

public Map<String,Filter> getFilters()

setFilters

public void setFilters(Map<String,Filter> filters)

getStandbyPosition

public Double getStandbyPosition()

setStandbyPosition

public void setStandbyPosition(Double standbyPosition)

loadFilter

public void loadFilter(Filter aFilter)
                throws org.lsst.ccs.bus.BadCommandException,
                       org.lsst.ccs.bus.ErrorInCommandExecutionException,
                       HardwareException

Load a filter from the loader to the camera. At the end of this operation the filter is grabbed on the autochanger at Handoff position.

Parameters:

aFilter -

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException

unloadFilter

public void unloadFilter(Filter aFilter)
                  throws org.lsst.ccs.bus.BadCommandException,
                         org.lsst.ccs.bus.ErrorInCommandExecutionException,
                         HardwareException

Unload a filter from the camera to the loader

Parameters:

aFilter -

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareException