org.lsst.ccs.subsystems.fcs

Class MainModule

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystems.fcs.MainModule

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, org.lsst.ccs.messaging.CommandExecutor, org.lsst.ccs.ServiceLifecycle, AlertRaiser

Direct Known Subclasses:

AutochangerMain, CarouselMain, FcsMain, LoaderMain

public abstract class MainModule
extends org.lsst.ccs.Subsystem
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

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.Agent

org.lsst.ccs.Agent.RunningCommand, org.lsst.ccs.Agent.ShutdownResult

Field Summary

Fields

Modifier and Type	Field and Description
protected BridgeToHardware	bridge
protected Map<String,EPOSController>	controllerList
protected org.lsst.ccs.services.DataProviderDictionaryService	dataProviderDictionaryService
protected AtomicBoolean	haltRequired
protected Map<String,MovedByEPOSController>	hardMovedByController
protected String	name
protected org.lsst.ccs.services.AgentPeriodicTaskService	periodicTaskService
protected AtomicBoolean	stopRequired
protected org.lsst.ccs.Subsystem	subs

Fields inherited from class org.lsst.ccs.Agent

AGENT_DESCRIPTION, AGENT_RUNTIMEINFO_TASK, commandExecutorLock, currentAction, currentQueries, currentSignals, jvmShutdown, logBusHandler, stateService, treeComponentInitialized

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

alertSeparator

Constructor Summary

Constructors

Constructor and Description
MainModule()

Method Summary

Modifier and Type	Method and Description
boolean	allDevicesBooted() This methods updates the boolean hardwareReady from the hardware bridge.
void	build() *** lifecycle methods *************************************************
void	checkControllers() Send command checkFault to each controllers.
void	checkFaultForAllControllers() Send command checkFault to each controller.
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()
Map<String,String>	getMobilNameControllerNameMap()
Map<Integer,String>	getSensorsMapPluggedOnPlutoGateway()
org.lsst.ccs.Subsystem	getSubsystem()
void	init()
abstract void	initializeHardware() initialize hardware after initialization.
boolean	isHaltRequired()
boolean	isInState(Enum state)
boolean	isStopRequired()
List<String>	listAcSensorsNames() For whole FCS GUI or autochanger GUI.
List<String>	listHardwareNames() Returns list of hardware names.
List<String>	listLoaderHardwareNames() For Whole FCS GUI.
List<String>	listLoSensorsNames() For loader GUI.
void	postShutdown()
void	publishData() for GUI
boolean	setTimedActionLoggingLevel(String levelName)
org.lsst.ccs.framework.TreeWalkerDiag	signal(org.lsst.ccs.framework.Signal signal)
void	updateAgentState(FcsEnumerations.AutochangerInclination inclinationS)
void	updateAgentState(FcsEnumerations.FilterReadinessState readinessS)
void	updateAgentState(FcsEnumerations.FilterState filterS)
void	updateAgentState(FcsEnumerations.McmState mcmS)
void	updateFCSStateToReady() Updates the FCS state and FCS readiness 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 org.lsst.ccs.Subsystem

getLogHandler, getLogHandlerLevel, getLogLevel, getNumberCommandThreads, isLogLevelInherited, ping, printLoggersLevel, printLogHandlersLevel, printRunningCommands, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth

Methods inherited from class org.lsst.ccs.Agent

createHelper, executeCommandRequest, getAgentInfo, getAgentPersistenceService, getAgentService, getAgentServices, getCommandCount, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getCurrentAction, getDescription, getEnvironmentLockService, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getName, getScheduler, helper, initAgent, initLogBusHandler, isInEngineeringMode, populateComponentLookup, preInit, preStart, printComponentNodeTree, publishMonitoringDataOnStatusBus, publishSubsystemDataOnStatusBus, sendAck, sendNack, sendStatusMessage, setAgentName, shutdownAgent, shutdownAgent, startAgent, vetoTransitionToNormalMode

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, raiseWarning, raiseWarning, raiseWarningOnlyEveryTenMinutes, raiseWarningOnlyIfNew

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

postBuild, postInit, postStart, shutdown, start

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterBuild, afterInit, afterStart, preBuild, preShutdown

Field Detail

name

@LookupName
protected String name

subs

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

periodicTaskService

@LookupField(strategy=TREE)
protected org.lsst.ccs.services.AgentPeriodicTaskService periodicTaskService

dataProviderDictionaryService

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

hardMovedByController

@LookupField(strategy=TREE)
protected final Map<String,MovedByEPOSController> hardMovedByController

controllerList

@LookupField(strategy=TREE)
protected final Map<String,EPOSController> controllerList

bridge

protected BridgeToHardware bridge

haltRequired

protected AtomicBoolean haltRequired

stopRequired

protected AtomicBoolean stopRequired

Constructor Detail

MainModule

public MainModule()

Method Detail

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

init

public void init()

Specified by:

init 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 overridden in FcsMainModule.

Returns:

listAcSensorsNames

@Command(type=QUERY,
         level=0,
         description="Return the list of names of sensors plugged on autochanger pluto gateway.")
public List<String> listAcSensorsNames()

For whole FCS GUI or autochanger GUI.

Returns:

listLoSensorsNames

@Command(type=QUERY,
         level=0,
         description="Return the list of names of sensors plugged on Loader pluto gateway.")
public List<String> listLoSensorsNames()

For loader GUI. For whole FCS GUI, it is overridden in FcsMain.

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:

getMobilNameControllerNameMap

@Command(type=QUERY,
         description="Return a map : couple of name of MobileItem and name of controller.",
         level=0)
public Map<String,String> getMobilNameControllerNameMap()

getSensorsMapPluggedOnPlutoGateway

public Map<Integer,String> getSensorsMapPluggedOnPlutoGateway()

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.

checkControllers

public void checkControllers()

Send command checkFault to each controllers. So if there was an issue detected on a controller, it will be known immediately (every 10 minutes should be enough).

checkFaultForAllControllers

@Command(type=QUERY,
         level=0,
         description="Check fault on each controller, after hardware initialization. Launched from Controllers overview GUI.")
public void checkFaultForAllControllers()

Send command checkFault to each controller. Used within Controllers viewer Panel

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 overridden in subclasses.

updateAgentState

public void updateAgentState(FcsEnumerations.FilterState filterS)

updateAgentState

public void updateAgentState(FcsEnumerations.FilterReadinessState readinessS)

updateAgentState

public void updateAgentState(FcsEnumerations.AutochangerInclination inclinationS)

updateAgentState

public void updateAgentState(FcsEnumerations.McmState mcmS)

isInState

public boolean isInState(Enum state)

getFilterReadinessState

public FcsEnumerations.FilterReadinessState getFilterReadinessState()

updateFCSStateToReady

@Command(type=ACTION,
         level=3,
         description="Force FCS state and FCS readiness state to be ready and publishes on the status bus. TO BE USED ONLY IN EXTREME CASES.")
public void updateFCSStateToReady()

Updates the FCS state and FCS readiness 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 readiness state and publishes on the status bus. This has to be overridden 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

setTimedActionLoggingLevel

@Command(type=ACTION,
         level=1,
         description="Change logging level of timed action, default is INFO")
public boolean setTimedActionLoggingLevel(String levelName)

postShutdown

public void postShutdown()

Specified by:

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