org.lsst.ccs.subsystem.common.actions

Class RefrigAction

java.lang.Object

org.lsst.ccs.subsystem.common.actions.RefrigAction

All Implemented Interfaces:

Serializable

public class RefrigAction
extends Object
implements Serializable

Manages the refrig alert action payload

Author:

saxton

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RefrigAction.Action

Field Summary

Fields

Modifier and Type	Field and Description
RefrigAction.Action	action
String	compName

Constructor Summary

Constructors

Constructor and Description
RefrigAction(RefrigAction.Action action, String compName) Constructor.

Method Summary

Modifier and Type	Method and Description
static void	addData(org.lsst.ccs.bus.data.Alert alert, RefrigAction.Action action) Adds data to an alert
static void	addData(org.lsst.ccs.bus.data.Alert alert, RefrigAction.Action action, String compName) Adds data to an alert
static String	getClientName() Gets the name of the client property.
static RefrigAction	getData(org.lsst.ccs.bus.data.Alert alert) Gets data from an alert.
static String	getManagerName() Gets the name of the manager property.
static String	getName() Gets the simple name of this class.

Methods inherited from class java.lang.Object

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

Field Detail

action

public RefrigAction.Action action

compName

public String compName

Constructor Detail

RefrigAction

public RefrigAction(RefrigAction.Action action,
                    String compName)

Constructor.

Parameters:

action - The action to perform

compName - The compressor name

Method Detail

getName

public static String getName()

Gets the simple name of this class.

Returns:

The name

getClientName

public static String getClientName()

Gets the name of the client property.

Returns:

The name

getManagerName

public static String getManagerName()

Gets the name of the manager property.

Returns:

The name

addData

public static void addData(org.lsst.ccs.bus.data.Alert alert,
                           RefrigAction.Action action,
                           String compName)

Adds data to an alert

Parameters:

alert - The alert

action - The action to perform

compName - The affected compressor name, or empty string if not applicable

addData

public static void addData(org.lsst.ccs.bus.data.Alert alert,
                           RefrigAction.Action action)

Adds data to an alert

Parameters:

alert - The alert

action - The action to perform

getData

public static RefrigAction getData(org.lsst.ccs.bus.data.Alert alert)

Gets data from an alert.

Parameters:

alert - The alert

Returns:

The action, or null if the alert doesn't contain RefrigAction payload