org.lsst.ccs.subsystem.refrig

Class Compressor

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystem.refrig.Compressor

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.SignalHandler, org.lsst.ccs.subsystem.monitor.Monitor.AlarmHandler

public class Compressor
extends org.lsst.ccs.framework.Module
implements org.lsst.ccs.framework.HardwareController, org.lsst.ccs.subsystem.monitor.Monitor.AlarmHandler

Implements the refrigeration compressor modular subsystem.

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

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

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields inherited from class org.lsst.ccs.framework.Module

environment, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
Compressor(String name, int tickMillis, int checkMillis, String configName, String compPowerLine, String heaterPowerLine, String resetLine) Main constructor.

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware() Initializes the hardware.
void	checkStarted() Checks whether hardware is started.
void	checkStopped() Checks whether hardware is stopped.
RefrigFullState	getFullState() Gets the full state of the refrigeration module.
void	initModule() Initializes the refrigeration subsystem.
void	processAlarm(int event, int parm) Handles alarm events.
void	reset() Resets the latches.
void	saveConfig() Saves the configuration data.
void	setCompPowerEnable(int value) Sets the compressor power state.
void	setHeaterPowerEnable(int value) Sets the heater power state.
void	setTickMillis(int value) Sets the tick period.
void	startTicking() Starts the subsystem.
void	tick() Performs periodic trending data broadcast.

Methods inherited from class org.lsst.ccs.framework.Module

alias, getComponentDictionariesTree, getComponentTree, getContext, getEnvironment, getMainDictionary, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, percolateSignal, postStart, processUpdate, publishData, publishData, publishData, publishData, publishData, publishData, publishData, sendSignal, sendSignal, sendSignalWithTimeLimit, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, shutdownNow, signal, update

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

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.Configurable

change, getCheckedValueFromConfiguration, getChildren, getComponentByName, getDictionary, getParent, getParentObject, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, proceduralWalk, publish, publish, publish, publish, publish, publish, start, treeWalk

Constructor Detail

Compressor

public Compressor(String name,
                  int tickMillis,
                  int checkMillis,
                  String configName,
                  String compPowerLine,
                  String heaterPowerLine,
                  String resetLine)

Main constructor.

Parameters:

name - The subsystem name.

tickMillis - The tick period (ms).

checkMillis - The hardware check period (ms).

configName - The name of the configuration.

compPowerLine - The name of the compressor power line.

heaterPowerLine - The name of the heater power line.

resetLine - The name of the PLC reset line

Method Detail

initModule

public void initModule()

Initializes the refrigeration subsystem.

Overrides:

initModule in class org.lsst.ccs.framework.Module

checkHardware

public org.lsst.ccs.framework.TreeWalkerDiag checkHardware()

Initializes the hardware.

Specified by:

checkHardware in interface org.lsst.ccs.framework.HardwareController

Returns:

GO

checkStarted

public void checkStarted()

Checks whether hardware is started.

Specified by:

checkStarted in interface org.lsst.ccs.framework.HardwareController

checkStopped

public void checkStopped()

Checks whether hardware is stopped.

Specified by:

checkStopped in interface org.lsst.ccs.framework.HardwareController

startTicking

public void startTicking()

Starts the subsystem.

Overrides:

startTicking in class org.lsst.ccs.framework.Module

tick

public void tick()

Performs periodic trending data broadcast.

Overrides:

tick in class org.lsst.ccs.framework.Module

setTickMillis

@Command(type=ACTION,
         description="Set the tick interval")
public void setTickMillis(int value)

Sets the tick period. Overrides the method in Module in order to publish a status update.

Overrides:

setTickMillis in class org.lsst.ccs.framework.Module

Parameters:

value - The tick period (milliseconds) to set.

processAlarm

public void processAlarm(int event,
                         int parm)

Handles alarm events.

Specified by:

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

Parameters:

event - The event type

parm - The event parameter

setCompPowerEnable

@Command(type=ACTION,
         description="Set the main power enabled state")
public void setCompPowerEnable(int value)

Sets the compressor power state.

Parameters:

value - The enabled state value to set: 0 = off, not 0 = on.

setHeaterPowerEnable

@Command(type=ACTION,
         description="Set the heater power enabled state")
public void setHeaterPowerEnable(int value)

Sets the heater power state.

Parameters:

value - The heater power state to set: 0 = off; not 0 = on.

reset

@Command(type=ACTION,
         description="Reset the latches")
public void reset()

Resets the latches.

saveConfig

@Command(type=ACTION,
         description="Save the current configuration")
public void saveConfig()
                                                                                             throws IOException

Saves the configuration data.

Throws:

IOException

getFullState

@Command(type=QUERY,
         description="Get the full refrigeration state")
public RefrigFullState getFullState()

Gets the full state of the refrigeration module. This is intended to be called by GUIs during initialization

Returns:

The full refrigeration state