org.lsst.ccs.subsystems.fcs.common

Interface AlertRaiser

All Superinterfaces:

org.lsst.ccs.UsesSubsystem

All Known Subinterfaces:

ControlledBySensors

All Known Implementing Classes:

APCTestBench2CanBusMain, AutochangerLatchModule, AutochangerMainModule, AutoChangerModule, AutochangerOnlineClampModule, AutochangerThreeOnlineClamps, AutochangerTruckModule, AutochangerTwoLatches, AutoChangerTwoTrucksModule, BasicAutoChangerModule, CanOpenADC, CanOpenDAC, CanOpenDevice, CanOpenEPOS, CanOpenEPOSLinearRailTruck, CanOpenEPOSOnlineClamp, CanOpenPlutoGateway, CanOpenProxy, CarouselClampModule, CarouselMainModule, CarouselModule, CarouselSocket, CompactIOModule, ComplementarySensors, FcsMainModule, LoaderCanOpenProxy, LoaderCarrierModule, LoaderClampModule, LoaderMainModule, MainModule, MobileItemModule, PlutoGatewayModule, SftAutoChangerModule, SftCarouselModule, SftFilterLatchModule, SftMainModule, SimuAutochangerLatchController, SimuAutochangerLinearRailController, SimuAutochangerOnlineClampController, SimuAutochangerPlutoGateway, SimuAutochangerStandalonePlutoGateway, SimuCanOpenADC, SimuCanOpenProxy, SimuCarouselClampController, SimuCarouselController, SimuCarouselStandalonePlutoGateway, SimuCompactIOModule, SimuEPOSControllerModule, SimuLoaderCarrierController, SimuLoaderClampController, SimuLoaderPlutoGateway, SimuLoaderStandalonePlutoGateway, SimuPlutoGateway, SimuPlutoGatewayWithFilterID

public interface AlertRaiser
extends org.lsst.ccs.UsesSubsystem

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

Author:

virieux

Method Summary

Modifier and Type	Method and Description
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, String deviceName) Raises an ALARM with a FcsAlert, a cause and a deviceName.
default void	raiseAlarm(String fcsErrorID, String message, Exception ex) Raises an ALARM with a fcsErrorID, a message and an exception.
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(String fcsErrorID, String message, Exception ex) Raises a WARNING with a fcsErrorID, a message and a cause.
default void	raiseWarning(String fcsErrorID, String message, String cause) Raises a WARNING alert with a fcsErrorID, a message and a cause.

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Method Detail

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,
                        String deviceName)

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

Parameters:

fcsAlert -

cause -

deviceName -

raiseAlarm

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

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(String fcsErrorID,
                          String message,
                          Exception ex)

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

Parameters:

fcsErrorID -

message -

ex -