org.lsst.ccs.subsystem.common.actions

Class RebPowerAction

java.lang.Object

org.lsst.ccs.subsystem.common.actions.RebPowerAction

All Implemented Interfaces:

Serializable

public class RebPowerAction
extends Object
implements Serializable

An descriptions of the Actions that can be taken by the Power Supply Agent. This enumeration, when sent as an Alarm payload, will trigger a response from the Reb Power Subsystem

Author:

The LSST CCS Team.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RebPowerAction.Type The type of Actions that can be taken.

Method Summary

Modifier and Type	Method and Description
static void	addRebPowerActionPayloadToAlert(org.lsst.ccs.bus.data.Alert alert, RebPowerAction.Type actionType, String rebPath) Add a given RebPowrAction payload to a given Alert.
String	getRebPath()
static RebPowerAction	getRebPowerActionPayloadFromAlert(org.lsst.ccs.bus.data.Alert alert) Get a RebPowerAction payload from the provided Alert.
RebPowerAction.Type	getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addRebPowerActionPayloadToAlert

public static void addRebPowerActionPayloadToAlert(org.lsst.ccs.bus.data.Alert alert,
                                                   RebPowerAction.Type actionType,
                                                   String rebPath)

Add a given RebPowrAction payload to a given Alert.

Parameters:

alert - The Alert to which the payload is to be added

actionType - The action to be taken.

rebPath - The path of the Reb to take the action on. This is in the form Rij/Reb[0-2]

getRebPowerActionPayloadFromAlert

public static RebPowerAction getRebPowerActionPayloadFromAlert(org.lsst.ccs.bus.data.Alert alert)

Get a RebPowerAction payload from the provided Alert.

Parameters:

alert - The Alert that might contain the payload

Returns:

The contained RebPowerAction payload. null if there is no payload.

getType

public RebPowerAction.Type getType()

getRebPath

public String getRebPath()