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, 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 static org.lsst.ccs.utilities.logging.Logger	fcslog
protected AtomicBoolean	haltRequired
protected boolean	hardwareReady

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

environment, log, name, nObserverThreads, registry, tickMillis

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	controlRealHardware()
void	initModule()
boolean	isHardwareReady() This methods updates the boolean hardwareReady from the hardware bridge.
String	listHardware() This method returns the list of hardware that this bridge will manage.
String	toString()

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

alias, change, dropConfigurationContext, getCheckedValueFromConfiguration, getChildren, getComponentByName, getComponentDictionariesTree, getComponentTree, getContext, getDictionary, getEnvironment, getMainDictionary, getModule, getName, getNObserverThreads, getObservables, getParent, getSubsystem, getTickMillis, init, injectResources, listens, newConfigurationContext, notifyChange, notifyChangeWithoutPreliminaryChecks, percolateSignal, processUpdate, publish, publish, publish, publish, publish, publish, publishData, publishData, publishData, publishData, publishData, publishData, publishData, register, sendSignal, sendSignal, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, setTickMillis, shutdownCommand, shutdownNow, signal, 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

Field Detail

fcslog

protected static final org.lsst.ccs.utilities.logging.Logger fcslog

bridge

protected BridgeToHardware bridge

hardwareReady

protected boolean hardwareReady

haltRequired

protected AtomicBoolean haltRequired

Constructor Detail

MainModule

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

Method Detail

initModule

public void initModule()

Overrides:

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

isHardwareReady

@Command(level=1,
         description="Return true if hardware is booted, identified and initialized.",
         type=QUERY)
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 log 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 can open hardware that this subsystem manage.",
         type=QUERY)
public String listHardware()

This method returns the list of hardware that this bridge will manage.

Returns:

toString

public String toString()

Overrides:

toString in class Object