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.framework.Configurable, org.lsst.ccs.framework.SignalHandler

Direct Known Subclasses:

APCTestBench2CanBusMain, AutochangerMainModule, CarouselMainModule, CPPMTestBenchMainModule, FcsMainModule, LoaderTestBenchMainModule, Scale1ProtoTestBenchMainModule, SftMainModule

public abstract class MainModule
extends org.lsst.ccs.framework.Module

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 boolean	hardwareReady
protected AtomicBoolean	stopRequired

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

environment, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
MainModule(String aName, int aTickMillis, 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	isHardwareReady() This methods updates the boolean hardwareReady from the hardware bridge.
String	listHardware() This method returns a String with the list of hardware that this bridge manages.
List<String>	listHardwareNames()
void	postStart() This happens when the hardware has been initialized.
org.lsst.ccs.framework.TreeWalkerDiag	signal(org.lsst.ccs.framework.Signal signal)
void	simulateAlert(String errorId, String alarmMsg)
void	simulateWarning(String errorId, String alarmMsg)
String	toString()
void	updateStateWithSensors()

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, start, submitChange, submitChanges, validateBulkChange

Field Detail

bridge

protected BridgeToHardware bridge

hardwareReady

protected boolean hardwareReady

haltRequired

protected AtomicBoolean haltRequired

stopRequired

protected AtomicBoolean stopRequired

Constructor Detail

MainModule

public MainModule(String aName,
                  int aTickMillis,
                  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

Overrides:

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

Throws:

org.lsst.ccs.HardwareException

isHardwareReady

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

This methods updates the boolean hardwareReady from the hardware bridge. But when the hardware is ready, it doesn't not ask hardware bridge again to avoid too much messages on the FCSLOG bus, could be replace by : return this.bridge.isHardwareReady();

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()

listHardware

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

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

Returns:

listHardwareNames

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

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()
                                                                                                                            throws FcsHardwareException,
                                                                                                                                   org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                                                                                                                   org.lsst.ccs.messaging.BadCommandException

Throws:

FcsHardwareException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

org.lsst.ccs.messaging.BadCommandException

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)

simulateWarning

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

toString

public String toString()

Overrides:

toString in class Object