org.lsst.ccs.subsystem.refrig

Class PrototypeColdPlateSubsystem

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.refrig.PrototypeColdPlateSubsystem

All Implemented Interfaces:

EventListener, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.CommandExecutor, org.lsst.ccs.ServiceLifecycle, org.lsst.ccs.services.alert.AlertListener

public class PrototypeColdPlateSubsystem
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.services.alert.AlertListener

Enables testing of the prototype cold plate.

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.Agent

org.lsst.ccs.Agent.RunningCommand, org.lsst.ccs.Agent.ShutdownResult

Field Summary

Fields inherited from class org.lsst.ccs.Agent

AGENT_DESCRIPTION, AGENT_RUNTIMEINFO_TASK, commandExecutorLock, currentAction, currentQueries, currentSignals, jvmShutdown, logBusHandler, stateService, treeComponentInitialized

Constructor Summary

Constructors

Constructor and Description
PrototypeColdPlateSubsystem() Constructor.

Method Summary

Modifier and Type	Method and Description
void	build() Build phase
void	clearLatch(String cond) Clears a (named) latched condition.
List<String>	getHeaterNames() Gets the list of heater names.
List<String>	getLatchNames() Gets the list of latched condition names.
List<String>	getSwitchNames() Gets the list of switch names.
PcpSysState	getSystemState() Gets the state of the PCP system.
void	init() Init phase.
void	onAlert(org.lsst.ccs.services.alert.AlertEvent event) Alert event handler.
void	postInit() Initializes the subsystem.
void	postStart() Starts the subsystem.
void	setHeaterPower(String htrName, double value) Sets a heater power value.
void	setHeaterState(String htrName, boolean on) Sets a heater state.
void	setNamedSwitchOn(String swch, boolean on) Turns a (named) switch on or off.

Methods inherited from class org.lsst.ccs.Subsystem

getLogHandler, getLogHandlerLevel, getLogLevel, getNumberCommandThreads, isLogLevelInherited, ping, printLoggersLevel, printLogHandlersLevel, printRunningCommands, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth

Methods inherited from class org.lsst.ccs.Agent

createHelper, executeCommandRequest, getAgentInfo, getAgentPersistenceService, getAgentService, getAgentServices, getCommandCount, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getCurrentAction, getDescription, getEnvironmentLockService, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getName, getScheduler, helper, initAgent, initLogBusHandler, isInEngineeringMode, populateComponentLookup, preInit, preStart, printComponentNodeTree, publishMonitoringDataOnStatusBus, publishSubsystemDataOnStatusBus, sendAck, sendNack, sendStatusMessage, setAgentName, shutdownAgent, shutdownAgent, startAgent, vetoTransitionToNormalMode

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

postBuild, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterBuild, afterInit, afterStart, preBuild, preShutdown

Constructor Detail

PrototypeColdPlateSubsystem

public PrototypeColdPlateSubsystem()

Constructor.

Method Detail

build

public void build()

Build phase

Specified by:

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

init

public void init()

Init phase. Register Alerts raised by this subsystem.

Specified by:

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

postInit

public void postInit()

Initializes the 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

getSystemState

@Command(type=QUERY,
         description="Get the PCP system state")
public PcpSysState getSystemState()

Gets the state of the PCP system.

Returns:

The PCP system state

getSwitchNames

@Command(type=QUERY,
         description="Get switch names")
public List<String> getSwitchNames()

Gets the list of switch names.

Returns:

The switch names.

setNamedSwitchOn

@Command(type=ACTION,
         description="Turn on/off a named switch")
public void setNamedSwitchOn(@Argument(description="The switch name")
                                                                                                      String swch,
                                                                                                      @Argument(description="Whether to turn on")
                                                                                                      boolean on)
                                                                                               throws RefrigException

Turns a (named) switch on or off.

Parameters:

swch - The switch name.

on - Whether to turn on or off

Throws:

RefrigException

getLatchNames

@Command(type=QUERY,
         description="Get latched condition names")
public List<String> getLatchNames()

Gets the list of latched condition names.

Returns:

The condition names.

clearLatch

@Command(type=ACTION,
         description="Clear a latched condition")
public void clearLatch(@Argument(description="The condition name")
                                                                                               String cond)
                                                                                        throws RefrigException

Clears a (named) latched condition.

Parameters:

cond - The condition name.

Throws:

RefrigException

getHeaterNames

@Command(type=QUERY,
         description="Get heater names")
public List<String> getHeaterNames()

Gets the list of heater names.

Returns:

The heater names.

setHeaterState

@Command(type=ACTION,
         description="Set a heater power enabled state")
public void setHeaterState(@Argument(description="The heater name")
                                                                                                          String htrName,
                                                                                                          @Argument(description="Whether to turn on")
                                                                                                          boolean on)
                                                                                                   throws RefrigException

Sets a heater state.

Parameters:

htrName - The heater name

on - Whether to set on

Throws:

RefrigException

setHeaterPower

@Command(type=ACTION,
         description="Set a heater power set point")
public void setHeaterPower(@Argument(description="The heater name")
                                                                                                      String htrName,
                                                                                                      @Argument(description="The power set point")
                                                                                                      double value)
                                                                                               throws RefrigException

Sets a heater power value.

Parameters:

htrName - The heater name

value - The power set point.

Throws:

RefrigException

onAlert

public void onAlert(org.lsst.ccs.services.alert.AlertEvent event)

Alert event handler. Resets PLC latch when corresponding alert is cleared.

Specified by:

onAlert in interface org.lsst.ccs.services.alert.AlertListener

Parameters:

event - The alert event