org.lsst.ccs.subsystems.fcs.common

Interface AlertRaiser

All Known Subinterfaces:

ControlledBySensors, EPOSController, EPOSControllerForCarousel, EPOSControllerForLinearRail, EPOSControllerWithBrake, PieceOfHardware, PlutoGatewayInterface, TTC580Interface

All Known Implementing Classes:

APCTestBench2CanBusMain, Autochanger, AutochangerLatch, AutochangerMain, AutochangerOnlineClamp, AutochangerThreeOnlineClamps, AutochangerTruck, AutochangerTwoLatches, AutochangerTwoTrucks, BasicAutoChanger, CanCBXAI420, CanCBXAI814, CanOpenDAC, CanOpenDevice, CanOpenEPOS, CanOpenEPOSCarousel, CanOpenEPOSLinearRailTruck, CanOpenEPOSOnlineClamp, CanOpenPlutoGateway, CanOpenProxy, CanOpenStrainGauge, CanOpenSystecIO, CanOpenTTC580, Carousel, CarouselClamp, CarouselMain, CarouselSocket, CompactIO, FcsMain, Loader, LoaderCarrier, LoaderClamp, LoaderMain, MainModule, MobileItem, PlutoGateway, SftAutoChanger, SftCarousel, SftFilterLatch, SftMain, SimuAutochangerLatchController, SimuAutochangerLinearRailController, SimuAutochangerOnlineClampController, SimuAutochangerPlutoGateway, SimuAutochangerStandalonePlutoGateway, SimuCanOpenADC, SimuCarouselClampController, SimuCarouselController, SimuCarouselStandalonePlutoGateway, SimuCompactIO, SimuEPOSController, SimuLoaderCarrierController, SimuLoaderClampController, SimuLoaderPlutoGateway, SimuLoaderStandalonePlutoGateway, SimuPlutoGateway, SimuPlutoGatewayWithFilterID, SimuTTC580, SystecIO_X5

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	alertSeparater 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
org.lsst.ccs.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	raiseAlarm(String fcsErrorID, String message, Exception ex) Deprecated.
default void	raiseAlarm(String fcsErrorID, String message, String cause) Raises an ALARM with a fcsErrorID, a message and a cause.
default void	raiseWarning(FcsEnumerations.FcsAlert fcsAlert, String cause) Raises a WARNING with an fcsAlert and a cause.
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	raiseWarning(String fcsErrorID, String message, Exception ex) Deprecated.
default void	raiseWarning(String fcsErrorID, String message, String cause) Raises a WARNING alert with a fcsErrorID, a message and a cause.

Field Detail

alertSeparater

static final char alertSeparater

to separate Alert Name or ID from device name.

See Also:

Constant Field Values

Method Detail

getAlertService

org.lsst.ccs.AlertService getAlertService()

return alertService

Returns:

raiseAlarm

default void raiseAlarm(String fcsErrorID,
                        String message,
                        String cause)

Raises an ALARM with a fcsErrorID, a message and a cause.

Parameters:

fcsErrorID -

message - description of the fcsErrorID

cause -

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 -

clearAlarm

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

Clear Alarm

Parameters:

fcsAlert -

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 -

raiseAlarm

@Deprecated
default void raiseAlarm(String fcsErrorID,
                                    String message,
                                    Exception ex)

Deprecated.

Raises an ALARM with a fcsErrorID, a message and an exception.

Parameters:

fcsErrorID -

message -

ex -

raiseWarning

default void raiseWarning(String fcsErrorID,
                          String message,
                          String cause)

Raises a WARNING alert with a fcsErrorID, a message and a cause.

Parameters:

fcsErrorID -

message - description of the fcsErrorID.

cause -

raiseWarning

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

Raises a WARNING with an fcsAlert and a cause.

Parameters:

fcsAlert -

cause -

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 -

raiseWarning

@Deprecated
default void raiseWarning(String fcsErrorID,
                                      String message,
                                      Exception ex)

Deprecated.

Raises a WARNING with a fcsErrorID, a message and a cause.

Parameters:

fcsErrorID -

message -

ex -

getName

String getName()

getSubsystem

org.lsst.ccs.Subsystem getSubsystem()