org.lsst.ccs.subsystems.fcs.common

Interface AlertRaiser

All Known Subinterfaces:

ADCInterface, ControlledBySensors, EPOSController, EPOSControllerForCarousel, EPOSControllerForLinearRail, EPOSControllerForOnlineClamp, EPOSControllerWithBrake, MonitorDeviceInterface, PieceOfHardware, PlutoGatewayInterface, PT100Interface, StrainGauge, TTC580Interface

All Known Implementing Classes:

APCTestBench2CanBusMain, Autochanger, AutochangerLatch, AutochangerMain, AutochangerOnlineClamp, AutochangerOnlineClampProto, AutochangerThreeOnlineClamps, AutochangerThreeOnlineClampsProto, AutochangerTruck, AutochangerTwoLatches, AutochangerTwoTrucks, CanCBXAI420, CanCBXAI814, CanOpenDAC, CanOpenDevice, CanOpenEPOS, CanOpenEPOSCarousel, CanOpenEPOSCarouselClamp, CanOpenEPOSLinearRailTruck, CanOpenEPOSOnlineClamp, CanOpenPlutoGateway, CanOpenProxy, CanOpenPT100, CanOpenSeneca4RTD, CanOpenStrainGauge, CanOpenSystecIO, CanOpenTTC580, Carousel, CarouselClamp, CarouselMain, CarouselSocket, FcsMain, Inclinometer, Loader, LoaderCanOpenProxy, LoaderCarrier, LoaderClamp, LoaderMain, MainModule, MobileItem, PlutoGateway, SimuAutochanger, SimuAutochangerLatchController, SimuAutochangerLinearRailController, SimuAutochangerOnlineClampController, SimuAutochangerPlutoGateway, SimuAutochangerStandalonePlutoGateway, SimuCanCBXAI420, SimuCanOpenADC, SimuCanOpenStrainGauge, SimuCarousel, SimuCarouselClampController, SimuCarouselController, SimuCarouselSocket, SimuCarouselStandalonePlutoGateway, SimuEPOSController, SimuLoaderCanOpenProxy, SimuLoaderCarrierController, SimuLoaderClampController, SimuLoaderPlutoGateway, SimuLoaderStandalonePlutoGateway, SimuPlutoGateway, SimuTTC580, TempMonitorDevice

public interface AlertRaiser

This interface is implemented by each class that can raises an Alert.

Author:

virieux

Field Summary

Fields

Modifier and Type	Field and Description
static char	alertSeparator to separate Alert Name or ID from device name.

Method Summary

Modifier and Type	Method and Description
default void	clearAlarm(FcsEnumerations.FcsAlert fcsAlert, String deviceName) Clear Alarm
default char	getAlertSeparator()
org.lsst.ccs.services.alert.AlertService	getAlertService() return alertService
String	getName()
org.lsst.ccs.Subsystem	getSubsystem()
default void	raiseAlarm(FcsEnumerations.FcsAlert fcsAlert, String cause) Raises an ALARM with a FcsAlert and a cause.
default void	raiseAlarm(FcsEnumerations.FcsAlert fcsAlert, String cause, Exception ex) Raises an ALARM with a FcsAlert, a cause and an Exception.
default void	raiseAlarm(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName) Raises an ALARM with a FcsAlert, a cause and a deviceName.
default void	raiseAlarm(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName, Exception ex) Raises an ALARM with a FcsAlert, a cause, a deviceName and an Exception
default void	raiseAlarmOnlyIfNew(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName)
default void	raiseAlertOnlyEveryTenMinutes(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName, org.lsst.ccs.bus.states.AlertState state)
default void	raiseAlertOnlyEveryTenMinutes(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName, Exception ex)
default void	raiseAlertOnlyIfNew(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName, org.lsst.ccs.bus.states.AlertState state) raise an alert only if it's a new alert.
default void	raiseWarning(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName) Raises an WARNING with a FcsAlert, a cause and a deviceName.
default void	raiseWarning(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName, Exception ex) Raises an WARNING with a FcsAlert, a cause, a deviceName and an exception.
default void	raiseWarningOnlyEveryTenMinutes(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName)
default void	raiseWarningOnlyIfNew(FcsEnumerations.FcsAlert fcsAlert, String cause, String deviceName)

Field Detail

alertSeparator

static final char alertSeparator

to separate Alert Name or ID from device name.

See Also:

Constant Field Values

Method Detail

getName

String getName()

getSubsystem

org.lsst.ccs.Subsystem getSubsystem()

getAlertService

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

return alertService

Returns:

getAlertSeparator

default char getAlertSeparator()

raiseAlarm

default void raiseAlarm(FcsEnumerations.FcsAlert fcsAlert,
                        String cause)

Raises an ALARM with a FcsAlert and a cause.

Parameters:

fcsAlert -

cause -

raiseAlarm

default void raiseAlarm(FcsEnumerations.FcsAlert fcsAlert,
                        String cause,
                        Exception ex)

Raises an ALARM with a FcsAlert, a cause and an Exception.

Parameters:

fcsAlert -

cause -

ex -

raiseAlarm

default void raiseAlarm(FcsEnumerations.FcsAlert fcsAlert,
                        String cause,
                        String deviceName)

Raises an ALARM with a FcsAlert, a cause and a deviceName.

Parameters:

fcsAlert -

cause -

deviceName -

raiseAlarm

default void raiseAlarm(FcsEnumerations.FcsAlert fcsAlert,
                        String cause,
                        String deviceName,
                        Exception ex)

Raises an ALARM with a FcsAlert, a cause, a deviceName and an Exception

Parameters:

fcsAlert -

cause -

deviceName -

ex -

clearAlarm

default void clearAlarm(FcsEnumerations.FcsAlert fcsAlert,
                        String deviceName)

Clear Alarm

Parameters:

fcsAlert -

deviceName -

raiseWarning

default void raiseWarning(FcsEnumerations.FcsAlert fcsAlert,
                          String cause,
                          String deviceName)

Raises an WARNING with a FcsAlert, a cause and a deviceName.

Parameters:

fcsAlert -

cause -

deviceName -

raiseWarning

default void raiseWarning(FcsEnumerations.FcsAlert fcsAlert,
                          String cause,
                          String deviceName,
                          Exception ex)

Raises an WARNING with a FcsAlert, a cause, a deviceName and an exception.

Parameters:

fcsAlert -

cause -

deviceName -

ex -

raiseAlertOnlyIfNew

default void raiseAlertOnlyIfNew(FcsEnumerations.FcsAlert fcsAlert,
                                 String cause,
                                 String deviceName,
                                 org.lsst.ccs.bus.states.AlertState state)

raise an alert only if it's a new alert. this method has to be used in periodic tasks to avoid having a too big volume of raised alerts.

Parameters:

fcsAlert -

cause -

deviceName -

state -

raiseAlertOnlyEveryTenMinutes

default void raiseAlertOnlyEveryTenMinutes(FcsEnumerations.FcsAlert fcsAlert,
                                           String cause,
                                           String deviceName,
                                           org.lsst.ccs.bus.states.AlertState state)

raiseAlarmOnlyIfNew

default void raiseAlarmOnlyIfNew(FcsEnumerations.FcsAlert fcsAlert,
                                 String cause,
                                 String deviceName)

raiseWarningOnlyIfNew

default void raiseWarningOnlyIfNew(FcsEnumerations.FcsAlert fcsAlert,
                                   String cause,
                                   String deviceName)

raiseWarningOnlyEveryTenMinutes

default void raiseWarningOnlyEveryTenMinutes(FcsEnumerations.FcsAlert fcsAlert,
                                             String cause,
                                             String deviceName)

raiseAlertOnlyEveryTenMinutes

default void raiseAlertOnlyEveryTenMinutes(FcsEnumerations.FcsAlert fcsAlert,
                                           String cause,
                                           String deviceName,
                                           Exception ex)