org.lsst.ccs.subsystems.fcs

Class MainModule

java.lang.Object

org.lsst.ccs.subsystems.fcs.MainModule

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, AlertRaiser

Direct Known Subclasses:

APCTestBench2CanBusMain, AutochangerMain, CarouselMain, FcsMain, LoaderMain

public abstract class MainModule
extends Object
implements AlertRaiser, org.lsst.ccs.framework.SignalHandler, org.lsst.ccs.framework.HasLifecycle

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

Field Summary

Fields

Modifier and Type	Field and Description
protected BridgeToHardware	bridge
protected org.lsst.ccs.services.DataProviderDictionaryService	dataProviderDictionaryService
protected AtomicBoolean	haltRequired
protected String	name
protected AtomicBoolean	stopRequired
protected org.lsst.ccs.Subsystem	subs

Fields inherited from interface org.lsst.ccs.subsystems.fcs.common.AlertRaiser

alertSeparator

Constructor Summary

Constructors

Constructor and Description
MainModule(BridgeToHardware bridge)

Method Summary

Modifier and Type	Method and Description
boolean	allDevicesBooted() This methods updates the boolean hardwareReady from the hardware bridge.
void	build() *** lifecycle methods *************************************************
org.lsst.ccs.services.alert.AlertService	getAlertService() return alertService
List<String>	getFilterNames() Return a list of filter names that the subsystem manages.
FcsEnumerations.FilterReadinessState	getFilterReadinessState()
String	getName()
org.lsst.ccs.Subsystem	getSubsystem()
abstract void	initializeHardware() initialize hardware after initialization.
boolean	isHaltRequired()
boolean	isInState(Enum state)
boolean	isStopRequired()
List<String>	listHardwareNames() Returns list of hardware names.
List<String>	listLoaderHardwareNames() For Whole FCS GUI.
void	postShutdown()
void	publishData() for GUI
org.lsst.ccs.framework.TreeWalkerDiag	signal(org.lsst.ccs.framework.Signal signal)
void	updateAgentState(FcsEnumerations.FilterReadinessState readinessS)
void	updateAgentState(FcsEnumerations.FilterState filterS)
void	updateFCSStateToReady() Updates the FCS state and FCS readyness state and publishes on the status bus.
void	updateGui() Read sensors and update state in reading sensors to update GUI.
abstract void	updateStateWithSensors() Update state in reading sensors.

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

clearAlarm, getAlertSeparator, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarmOnlyIfNew, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyIfNew, raiseWarning, raiseWarning, raiseWarningOnlyEveryTenMinutes, raiseWarningOnlyIfNew

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

init, postBuild, postInit, postStart, shutdown, start

Field Detail

name

@LookupName
protected String name

subs

@LookupField(strategy=TOP)
protected org.lsst.ccs.Subsystem subs

dataProviderDictionaryService

@LookupField(strategy=TREE)
protected org.lsst.ccs.services.DataProviderDictionaryService dataProviderDictionaryService

bridge

protected BridgeToHardware bridge

haltRequired

protected AtomicBoolean haltRequired

stopRequired

protected AtomicBoolean stopRequired

Constructor Detail

MainModule

public MainModule(BridgeToHardware bridge)

Method Detail

getName

public String getName()

Specified by:

getName in interface AlertRaiser

getSubsystem

public org.lsst.ccs.Subsystem getSubsystem()

Specified by:

getSubsystem in interface AlertRaiser

getAlertService

public org.lsst.ccs.services.alert.AlertService getAlertService()

Description copied from interface: AlertRaiser

return alertService

Specified by:

getAlertService in interface AlertRaiser

Returns:

isHaltRequired

public boolean isHaltRequired()

isStopRequired

public boolean isStopRequired()

build

public void build()

*** lifecycle methods *************************************************

Specified by:

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

allDevicesBooted

@Command(type=QUERY,
         level=1,
         description="Return true if all hardware is booted with the correct serial number.")
public boolean allDevicesBooted()

This methods updates the boolean hardwareReady from the hardware bridge.

Returns:

true if hardware is booted, identified and initialized

listHardwareNames

@Command(type=QUERY,
         level=0,
         description="Returns the list of CANopen hardware managed by this subsystem.")
public List<String> listHardwareNames()

Returns list of hardware names. Used by GUI.

Returns:

list of hardware this MainModule manages.

listLoaderHardwareNames

@Command(type=QUERY,
         level=0,
         description="Return the list of LOADER CANopen hardware managed by this subsystem.")
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=0,
         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 abstract void updateStateWithSensors()

Update state in reading sensors. This method has to be overridden by subclasses.

Throws:

FcsHardwareException

updateGui

public void updateGui()

Read sensors and update state in reading sensors to update GUI.

initializeHardware

@Command(type=QUERY,
         level=1,
         description="Check hardware after initialization. To be executed if during boot process some hardware is missing.")
public abstract void initializeHardware()

initialize hardware after initialization. to be executed if during boot process some hardware is missing. this method had to be overriden in subclasses.

updateAgentState

public void updateAgentState(FcsEnumerations.FilterState filterS)

updateAgentState

public void updateAgentState(FcsEnumerations.FilterReadinessState readinessS)

isInState

public boolean isInState(Enum state)

getFilterReadinessState

public FcsEnumerations.FilterReadinessState getFilterReadinessState()

updateFCSStateToReady

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

Updates the FCS state and FCS readyness state and publishes on the status bus. Checks that 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.

signal

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

Specified by:

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

publishData

@Command(type=QUERY,
         level=0,
         description="Publish Data to populate GUI.")
public void publishData()

for GUI

postShutdown

public void postShutdown()

Specified by:

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