org.lsst.ccs.subsystems.fcs

Class MainModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.MainModule

All Implemented Interfaces:

Observer, org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, AlertRaiser, org.lsst.ccs.UsesSubsystem

Direct Known Subclasses:

APCTestBench2CanBusMain, AutochangerMainModule, CarouselMainModule, CPPMTestBenchMainModule, FcsMainModule, LoaderMainModule, SftMainModule

public class MainModule
extends org.lsst.ccs.framework.Module
implements AlertRaiser

This is the Main Module for every software related to the Filters Exchanger : - single-filter-test control-command - scale 1 prototype control-command - real Filters Exchanger This class is designed to gather the commons methods to all these softwares.

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

Modifier and Type	Field and Description
protected BridgeToHardware	bridge
protected AtomicBoolean	haltRequired
protected AtomicBoolean	stopRequired

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

name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
MainModule(BridgeToHardware bridge)

Method Summary

Modifier and Type	Method and Description
boolean	controlRealHardware()
List<String>	getFilterNames() Return a list of filter names that the subsystem manages.
AtomicBoolean	getHaltRequired()
AtomicBoolean	getStopRequired()
TcpProxyInterface	getTcpProxy()
void	initModule()
boolean	isCANDevicesReady() This methods updates the boolean hardwareReady from the hardware bridge.
List<String>	listHardwareNames()
List<String>	listLoaderHardwareNames() For Whole FCS GUI.
void	postStart() This happens when the hardware has been initialized.
String	printHardwareList() This method returns a String with the list of hardware that this bridge manages.
String	printHardwareState()
org.lsst.ccs.framework.TreeWalkerDiag	signal(org.lsst.ccs.framework.Signal signal)
void	simulateAlert(String errorId, String alarmMsg) Just for tests.
void	simulateWarning(String errorId, String alarmMsg) Just for tests.
void	updateFCSState() Check that Carousel hardware is ready to be operated and moved.
void	updateStateWithSensors() Update state in reading sensors.

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

getNObserverThreads, getObservables, getTickMillis, init, listens, processUpdate, sendSignal, sendSignalWithTimeLimit, 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.subsystems.fcs.common.AlertRaiser

raiseAlarm, raiseAlarm, raiseAlarm, raiseWarning, raiseWarning, raiseWarning

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

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

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

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

setParameterBulk

Field Detail

bridge

protected BridgeToHardware bridge

haltRequired

protected AtomicBoolean haltRequired

stopRequired

protected AtomicBoolean stopRequired

Constructor Detail

MainModule

public MainModule(BridgeToHardware bridge)

Method Detail

getHaltRequired

public AtomicBoolean getHaltRequired()

getStopRequired

public AtomicBoolean getStopRequired()

initModule

public void initModule()

Overrides:

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

postStart

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

This happens when the hardware has been initialized. (after completeInitialization). It starts the ticking in super.postStart().

Specified by:

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

Specified by:

postStart in interface org.lsst.ccs.framework.HasLifecycle

Throws:

org.lsst.ccs.HardwareException

isCANDevicesReady

@Command(level=1,
         type=QUERY,
         description="Return true if hardware is booted, identified and initialized.")
public boolean isCANDevicesReady()

This methods updates the boolean hardwareReady from the hardware bridge.

Returns:

true if hardware is booted, identified and initialized

controlRealHardware

@Command(type=QUERY,
         description="Return true if this main module controls real hardware.")
public boolean controlRealHardware()

printHardwareList

@Command(level=1,
         description="Return a printed list of CANopen hardware that this subsystem manages.",
         type=QUERY)
public String printHardwareList()

This method returns a String with the list of hardware that this bridge manages.

Returns:

printHardwareState

@Command(type=QUERY,
         level=1,
         description="Return the list if initialized hardware for debug purpose.")
public String printHardwareState()

listHardwareNames

@Command(level=1,
         description="Return the list of CANopen hardware that this subsystem manages.",
         type=QUERY)
public List<String> listHardwareNames()

listLoaderHardwareNames

@Command(level=1,
         description="Return the list of LOADER CANopen hardware that this subsystem manages.",
         type=QUERY)
public List<String> listLoaderHardwareNames()

For Whole FCS GUI. Has to be overriden in FcsMainModule.

Returns:

getFilterNames

@Command(type=QUERY,
         description="Return the list of names of filters  that this subsystem manages.",
         level=1,
         alias="listFilterNames")
public List<String> getFilterNames()

Return a list of filter names that the subsystem manages. For the GUI or the Console.

Returns:

updateStateWithSensors

@Command(type=QUERY,
         level=0,
         description="Update state in reading sensors.")
public void updateStateWithSensors()

Update state in reading sensors.

Throws:

FcsHardwareException

updateFCSState

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

Check that Carousel hardware is ready to be operated and moved. This means that : - all CAN open devices are booted, identified and initialized, - homing has been done on the controllers. This updates the FCS state and FCS readyness state and publishes on the status bus. This has to be overriden if there is other initializations to do on the hardware like homing.

getTcpProxy

public TcpProxyInterface getTcpProxy()

signal

public org.lsst.ccs.framework.TreeWalkerDiag signal(org.lsst.ccs.framework.Signal signal)

Specified by:

signal in interface org.lsst.ccs.framework.SignalHandler

Overrides:

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

simulateAlert

@Command(type=QUERY,
         level=1,
         description="For tests purpose only - raise an ALERT.")
public void simulateAlert(String errorId,
                                                                                                                                  String alarmMsg)

Just for tests.

Parameters:

errorId -

alarmMsg -

simulateWarning

@Command(type=QUERY,
         level=1,
         description="For tests purpose only - raise an ALERT.")
public void simulateWarning(String errorId,
                                                                                                                                    String alarmMsg)

Just for tests.

Parameters:

errorId -

alarmMsg -