org.lsst.ccs.subsystem.refrig

Class ThermalMain

java.lang.Object

org.lsst.ccs.subsystem.refrig.ThermalMain

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.AgentPresenceListener, org.lsst.ccs.messaging.MessageListener, org.lsst.ccs.messaging.StatusMessageListener

public class ThermalMain
extends Object
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.AgentPresenceListener, org.lsst.ccs.messaging.StatusMessageListener, org.lsst.ccs.framework.ClearAlertHandler

Implements the refrigeration thermal control subsystem.

Author:

Owen Saxton

Nested Class Summary

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

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Constructor Summary

Constructors

Constructor and Description
ThermalMain()

Method Summary

Modifier and Type	Method and Description
void	build() Build phase
org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode	canClearAlert(org.lsst.ccs.bus.data.Alert alert, org.lsst.ccs.bus.states.AlertState alertState) Callback to clear an Alert instance.
void	connected(org.lsst.ccs.bus.data.AgentInfo... agents) Listens for the arrival of the companion refrigeration subsystem.
void	disconnected(org.lsst.ccs.bus.data.AgentInfo... agents) Listens for the departure of the companion refrigeration subsystem.
ThermalState	getSystemState() Gets the state of the thermal control system.
void	onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage msg) Handles refrigeration status messages.
void	postInit() Initializes the thermal subsystem.
void	postStart() Starts the subsystem.
void	setAuxHeaterPower(int htr, double value) Sets an aux heater power value.
void	setAuxHeaterState(int htr, int value) Sets an aux heater state.
void	setPlateTemperature(int htr, double temp) Sets a plate temperature value.
void	setTrimHeaterPower(int htr, double power) Sets a trim heater power value.
void	setTrimHeaterState(int htr, TrimHeaterOpState state) Sets a trim heater operation state.
void	setUpdatePeriod(int value) Sets the monitor update period.

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

init, postBuild, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.messaging.AgentPresenceListener

connecting, disconnecting

Constructor Detail

ThermalMain

public ThermalMain()

Method Detail

build

public void build()

Build phase

Specified by:

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

postInit

public void postInit()

Initializes the thermal subsystem.

Specified by:

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

postStart

public void postStart()

Starts the subsystem.

Specified by:

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

connected

public void connected(org.lsst.ccs.bus.data.AgentInfo... agents)

Listens for the arrival of the companion refrigeration subsystem.

Specified by:

connected in interface org.lsst.ccs.messaging.AgentPresenceListener

Parameters:

agents - Array of agents present

disconnected

public void disconnected(org.lsst.ccs.bus.data.AgentInfo... agents)

Listens for the departure of the companion refrigeration subsystem.

Specified by:

disconnected in interface org.lsst.ccs.messaging.AgentPresenceListener

Parameters:

agents - Agents going absent

onStatusMessage

public void onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage msg)

Handles refrigeration status messages.

Specified by:

onStatusMessage in interface org.lsst.ccs.messaging.StatusMessageListener

Parameters:

msg - The status message

getSystemState

@Command(type=QUERY,
         description="Get the thermal control state",
         level=0)
public ThermalState getSystemState()

Gets the state of the thermal control system. This is intended to be called by GUIs during initialization

Returns:

The thermal control state

setUpdatePeriod

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

Sets the monitor update period.

Parameters:

value - The period (milliseconds) to set.

setTrimHeaterState

@Command(type=ACTION,
         description="Set a trim heater operation state")
public void setTrimHeaterState(int htr,
                                                                                                               TrimHeaterOpState state)
                                                                                                        throws RefrigException

Sets a trim heater operation state.

Parameters:

htr - The heater number

state - The heater operation state to set: OFF, POWER or TEMP.

Throws:

RefrigException

setTrimHeaterPower

@Command(type=ACTION,
         description="Set a trim heater power set point")
public void setTrimHeaterPower(int htr,
                                                                                                               double power)
                                                                                                        throws RefrigException

Sets a trim heater power value.

Parameters:

htr - The heater number

power - The load power set point.

Throws:

RefrigException

setPlateTemperature

@Command(type=ACTION,
         description="Set a plate temperature set point")
public void setPlateTemperature(int htr,
                                                                                                                double temp)
                                                                                                         throws RefrigException

Sets a plate temperature value.

Parameters:

htr - The heater number

temp - The plate temperature set point.

Throws:

RefrigException

setAuxHeaterState

@Command(type=ACTION,
         description="Set an aux heater power enabled state")
public void setAuxHeaterState(int htr,
                                                                                                                  int value)
                                                                                                           throws RefrigException

Sets an aux heater state.

Parameters:

htr - The heater number

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

Throws:

RefrigException

setAuxHeaterPower

@Command(type=ACTION,
         description="Set an aux heater power set point")
public void setAuxHeaterPower(int htr,
                                                                                                              double value)
                                                                                                       throws RefrigException

Sets an aux heater power value.

Parameters:

htr - The heater number

value - The power set point.

Throws:

RefrigException

canClearAlert

public org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode canClearAlert(org.lsst.ccs.bus.data.Alert alert,
                                                                             org.lsst.ccs.bus.states.AlertState alertState)

Callback to clear an Alert instance. Return a ClearAlertCode for the provided Alert.

Specified by:

canClearAlert in interface org.lsst.ccs.framework.ClearAlertHandler

Parameters:

alert - The Alert instance to clear.

alertState - The AlertState for the provided Alert.

Returns:

A ClearAlertCode to indicate which action is to be taken by the framework.