org.lsst.ccs.subsystem.vacuum

Class VacuumMain

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.vacuum.VacuumMain

All Implemented Interfaces:

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

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

The camera vacuum system

Author:

The LSST CCS Team

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

Constructor Summary

Constructors

Constructor and Description
VacuumMain() Constructor

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	clearLatch(int cond) Clears a latched condition.
List<String>	getSwitchNames() Gets the list of switch names.
VacSysState	getVacuumState() Gets the state of the Vacuum system.
void	onAlert(org.lsst.ccs.services.alert.AlertEvent event) Alert event handler.
void	postInit() Post initialization phase
void	postStart() Post start
void	setSwitchOn(String name, boolean on) Turns a switch on or off.

Methods inherited from class org.lsst.ccs.Subsystem

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

Methods inherited from class org.lsst.ccs.Agent

broadcastStatus, checkAllHardwareStopped, createHelper, executeCommandRequest, getAgentInfo, getAgentPersistenceService, getAgentService, getAgentServices, getCCSVersions, getCommandCount, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getCurrentAction, getDescription, getDistributionInfo, getEnvironmentLockService, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getName, getScheduler, getStatusBroadcastPeriod, helper, initAgent, internalCheckHardware, isConnectedToTheBuses, isInEngineeringMode, populateComponentLookup, preBuild, printComponentNodeTree, publishSubsystemDataOnStatusBus, sendAck, sendNack, sendStatusMessage, setAgentName, 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

init, postBuild, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, afterStart, preInit, preShutdown, preStart

Constructor Detail

VacuumMain

public VacuumMain()

Constructor

Method Detail

build

public void build()

Build phase

Specified by:

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

postInit

public void postInit()

Post initialization phase

Specified by:

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

postStart

public void postStart()

Post start

Specified by:

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

getVacuumState

@Command(type=QUERY,
         description="Get the vacuum system state",
         level=0)
public VacSysState getVacuumState()

Gets the state of the Vacuum system.

Returns:

The vacuum state

getSwitchNames

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

Gets the list of switch names.

Returns:

The switch names.

Throws:

VacuumException

setSwitchOn

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

Turns a switch on or off.

Parameters:

name - The switch name.

on - Whether to turn on or off

Throws:

VacuumException

clearLatch

@Command(type=ACTION,
         description="Clear a condition")
public void clearLatch(@Argument(description="The condition number")
                                                                                       int cond)
                                                                                throws VacuumException

Clears a latched condition.

Parameters:

cond - The condition number.

Throws:

VacuumException

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.

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.

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