org.lsst.ccs.subsystem.refrig

Class Compressor

java.lang.Object

org.lsst.ccs.subsystem.refrig.Compressor

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.monitor.Monitor.AlarmHandler

Direct Known Subclasses:

ColdCompressor, CryoCompressor

public class Compressor
extends Object
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.monitor.Monitor.AlarmHandler

Controls a refrigeration compressor.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Compressor.SwitchDevice

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.ClearAlertHandler

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Field Summary

Fields inherited from interface org.lsst.ccs.monitor.Monitor.AlarmHandler

alarms

Constructor Summary

Constructors

Constructor and Description
Compressor(CompState state) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getIndex() Gets the compressor index.
CompState	getState() Gets the compressor state.
void	postInit() Initializes the compressor control.
boolean	processAlarm(int event, int parm, String cause, String name) Handles alarm events.
void	resetLatches() Resets the latches.
void	setIndex(int index) Sets the compressor index.
void	setSwitchOn(int sw, boolean on) Turns a switch on or off..
boolean	updateState() Updates the compressor state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, init, postBuild, postShutdown, postStart, shutdown, start

Methods inherited from interface org.lsst.ccs.monitor.Monitor.AlarmHandler

canClearAlert, getAlarmById, setAlarms

Methods inherited from interface org.lsst.ccs.framework.ClearAlertHandler

canClearAlert

Constructor Detail

Compressor

public Compressor(CompState state)

Constructor.

Parameters:

state - The compressor state object

Method Detail

postInit

public void postInit()

Initializes the compressor control.

Specified by:

postInit in interface org.lsst.ccs.framework.HasLifecycle

setIndex

public void setIndex(int index)

Sets the compressor index.

Parameters:

index - The index value

getIndex

public int getIndex()

Gets the compressor index.

Returns:

The index value

setSwitchOn

@Command(type=ACTION,
         description="Set a compressor\'s switch state")
public void setSwitchOn(@Argument(description="Switch number")
                                                                                                       int sw,
                                                                                                       @Argument(description="Whether to turn on")
                                                                                                       boolean on)
                                                                                                throws RefrigException

Turns a switch on or off..

Parameters:

sw - The switch ID

on - Whether to turn on

Throws:

RefrigException

resetLatches

@Command(type=ACTION,
         description="Reset a compressor\'s latches")
public void resetLatches()

Resets the latches.

updateState

public boolean updateState()

Updates the compressor state.

Returns:

Whether any value changed

getState

public CompState getState()

Gets the compressor state.

Returns:

The compressor state

processAlarm

public boolean processAlarm(int event,
                            int parm,
                            String cause,
                            String name)

Handles alarm events.

Specified by:

processAlarm in interface org.lsst.ccs.monitor.Monitor.AlarmHandler

Parameters:

event - The event type

parm - The event parameter

cause - The alarm cause

name - The alarm name

Returns:

Whether to process further as an alarm