org.lsst.ccs.subsystem.refrig

Class RefrigMain

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.refrig.RefrigMain

All Implemented Interfaces:

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

public class RefrigMain
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.monitor.Monitor.AlarmHandler

Implements the refrigeration compressor subsystem.

Author:

Owen Saxton

Nested Class Summary

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

org.lsst.ccs.Agent.RunningCommand

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

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Field Summary

Fields inherited from class org.lsst.ccs.Agent

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

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

alarms

Constructor Summary

Constructors

Constructor and Description
RefrigMain() Constructor.

Method Summary

Modifier and Type	Method and Description
void	build() Build phase
RefrigState	getSystemState() Gets the state of the refrigeration module.
void	postInit() Initializes the refrigeration subsystem.
void	postStart() Starts the subsystem.
boolean	processAlarm(int event, int parm, String cause, String name) Handles alarm events.
void	setUpdatePeriod(int value) Sets the monitor update period.

Methods inherited from class org.lsst.ccs.Subsystem

getLogHandler, getNumberCommandThreads, ping, printRunningCommands, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth, switchToEngineeringMode, switchToNormalMode

Methods inherited from class org.lsst.ccs.Agent

addCommandSet, addCommandsFromObject, addStateChangeListener, broadcastStatus, checkAllHardwareStopped, createHelper, executeCommandRequest, getAgentInfo, getAgentLockService, getAgentPeriodicTaskService, getAgentPersistenceService, getAgentService, getAgentServices, getAgentStatusAggregatorService, getAlertService, getCCSVersions, getCommandCount, getCommandSet, getCommandTargets, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getConfigurationService, getCurrentAction, getDataProviderDictionaryService, getDescription, getDictionaries, getDistributionInfo, getEnvironmentLockService, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getMonitor, getName, getScheduler, getState, getState, getStatusBroadcastPeriod, helper, internalCheckHardware, isConnectedToTheBuses, isInEngineeringMode, isInState, isInState, populateComponentLookup, preBuild, preInit, printComponentNodeTree, publishSubsystemDataOnStatusBus, removeStateChangeListener, sendAck, sendNack, setAgentName, setAgentProperty, shutdownAgent, startAgent, startAgent, updateAgentComponentState, updateAgentState, updateAgentState, updateHeartBeat, waitFor

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.monitor.Monitor.AlarmHandler

canClearAlert, getAlarmById, setAlarms

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

canClearAlert

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, preShutdown, preStart

Constructor Detail

RefrigMain

public RefrigMain()

Constructor.

Method Detail

build

public void build()

Build phase

Specified by:

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

postInit

public void postInit()

Initializes the refrigeration 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 refrigeration state")
public RefrigState getSystemState()

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

Returns:

The refrigeration 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.

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