org.lsst.ccs.subsystems.fcs.common

Interface MovedByEPOSController

All Superinterfaces:

org.lsst.ccs.UsesSubsystem

All Known Implementing Classes:

AutochangerLatchModule, AutochangerOnlineClampModule, AutochangerTruckModule, LoaderCarrierModule, LoaderClampModule

public interface MovedByEPOSController
extends org.lsst.ccs.UsesSubsystem

This interface is to be implemented by every class which is a model for a hardware that is moved by an EPOSController. The goal of this interface is to factorise methods to process emergency messages coming from the CANbus either when a controller is in fault or when a command faultReset has been sent to the controller.

Author:

virieux

Method Summary

Modifier and Type	Method and Description
String	getControllerName() Return the name of the controller.
boolean	isControllerInFault() Return true if the controller is in fault (an EmergencyMessage has been previously received.)
default void	processEmergencyMessage(EmergencyMessage emcyMsg) This method is to be used when receiving an EmergencyMessage from the CANbus.
default void	processFaultReset() What to do when a faultReset has been done on the controller.
void	publishData() publishes data on the STATUS bus
void	setControllerInFault(boolean controllerInFault)
default void	updateControllerInFault(String controllerName, org.lsst.ccs.framework.Module.ValueUpdate v) Updates field controllerInFault when the controller notifies its observers and sends new values.

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Method Detail

getControllerName

String getControllerName()

Return the name of the controller.

Returns:

isControllerInFault

boolean isControllerInFault()

Return true if the controller is in fault (an EmergencyMessage has been previously received.)

Returns:

setControllerInFault

void setControllerInFault(boolean controllerInFault)

Parameters:

controllerInFault -

publishData

void publishData()

publishes data on the STATUS bus

updateControllerInFault

default void updateControllerInFault(String controllerName,
                                     org.lsst.ccs.framework.Module.ValueUpdate v)

Updates field controllerInFault when the controller notifies its observers and sends new values. Publishes data when controller is in fault or after a faultReset. The class which implements this interface must observe its controller. Needed to update the GUI.

Parameters:

controllerName -

v -

processEmergencyMessage

default void processEmergencyMessage(EmergencyMessage emcyMsg)

This method is to be used when receiving an EmergencyMessage from the CANbus. An emergency message for a controller can be received from the CANbus in 2 cases: - a faultReset has been previously sent to the controller, in this case the error code of the emergency message is "00", - or when a new error is detected by the controller device, in this case the error code is different from "00". This method updates the boolean controllerInFault and publishes data. It's useful for the GUI and the monitoring of the hardware.

Parameters:

emcyMsg - the emergency message to be processed.

processFaultReset

default void processFaultReset()

What to do when a faultReset has been done on the controller.