org.lsst.ccs.subsystem.refrig
Class RefrigTest

java.lang.Object
  extended by java.util.Observable
      extended by org.lsst.ccs.framework.Module
          extended by org.lsst.ccs.subsystem.refrig.RefrigTest
All Implemented Interfaces:
Serializable, Observer, org.lsst.ccs.framework.Configurable
Direct Known Subclasses:
RefrigTestHdw, RefrigTestSim

public abstract class RefrigTest
extends org.lsst.ccs.framework.Module

Implements the refrigeration long lines test modular subsystem

This is an abstract class implementing the interactions with the CCS buses, but deferring the hardware interaction, real or simulated, to sub-classes.

Author:
Owen Saxton
See Also:
Serialized Form

Nested Class Summary
static class RefrigTest.Channel
          Inner container class for channel parameters
 
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, registry, tickMillis
 
Constructor Summary
RefrigTest(String name, int tickMillis, String configName)
          Main constructor
 
Method Summary
 RefrigFullState getFullState()
          Gets the full state of the refrigeration module
 void initModule()
          Initializes the refrigeration subsystem
 void saveConfiguration()
          Saves the configuration data
 void setHighLimit(int id, double limit)
          Sets the high limit for a channel
 void setLoadTripEnable(int value)
          Sets the load power trip enabled state on or off
 void setLowLimit(int id, double limit)
          Sets the low limit for a channel
 void setMainPowerEnable(int value)
          Sets the main power enabled state on or off
 void setMainPowerEnable(int value, boolean publish)
          Sets the main power enabled state on or off
 void setTickMillis(int value)
          Sets the tick period
 void tick()
          Performs periodic trending data broadcast
 
Methods inherited from class org.lsst.ccs.framework.Module
alias, change, checkHardware, dropConfigurationContext, getCheckedValueFromConfiguration, getChildren, getContext, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, newConfigurationContext, notifyChange, notifyChangeWithoutPreliminaryChecks, processUpdate, publishData, publishData, publishData, publishData, register, register, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, shutdownCommand, shutdownNow, start, startTicking, 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
 

Constructor Detail

RefrigTest

public RefrigTest(String name,
                  int tickMillis,
                  String configName)
Main constructor

Method Detail

initModule

public void initModule()
Initializes the refrigeration subsystem

Overrides:
initModule 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

@BusCommand
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.

setMainPowerEnable

@BusCommand
public void setMainPowerEnable(int value)
Sets the main power enabled state on or off

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

setMainPowerEnable

@BusCommand
public void setMainPowerEnable(int value,
                                          boolean publish)
Sets the main power enabled state on or off

Parameters:
value - The enabled state value to set: 0 = off, ~0 = on.
publish - If true, publish the new state on the status bus.

setLoadTripEnable

@BusCommand
public void setLoadTripEnable(int value)
Sets the load power trip enabled state on or off

Parameters:
value - The load trip enabled state value to set: 0 = off; ~0 = on.

setLowLimit

@BusCommand
public void setLowLimit(int id,
                                   double limit)
                 throws Exception
Sets the low limit for a channel

Parameters:
id - The channel ID
limit - The low limit value.
Throws:
Exception

setHighLimit

@BusCommand
public void setHighLimit(int id,
                                    double limit)
                  throws Exception
Sets the high limit for a channel

Parameters:
id - The channel ID
limit - The high limit value.
Throws:
Exception

saveConfiguration

@BusCommand
public void saveConfiguration()
                       throws IOException
Saves the configuration data

Throws:
IOException

getFullState

@BusCommand
public RefrigFullState getFullState()
Gets the full state of the refrigeration module

This is intended to be called by GUIs during initialization



Copyright © 2013 LSST. All Rights Reserved.