org.lsst.ccs.subsystem.power

Class QuadBox

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.power.QuadBox

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.CommandExecutor, org.lsst.ccs.ServiceLifecycle

public class QuadBox
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle

Implements the Quad Box control subsystem.

Author:

Owen Saxton

Nested Class Summary

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

org.lsst.ccs.Agent.RunningCommand

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
QuadBox() Constructor.

Method Summary

Modifier and Type	Method and Description
void	build() Build phase
QuadBoxState	getFullState() Gets the full quad box state.
List<String>	getSwitchNames() Gets the list of switch names.
void	postInit() Subsystem post-initialization
void	postStart() Starts the subsystem.
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, preInit, 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, preShutdown, preStart

Constructor Detail

QuadBox

public QuadBox()

Constructor.

Method Detail

build

public void build()

Build phase

Specified by:

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

postInit

public void postInit()

Subsystem post-initialization

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

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 PowerException

Turns a switch on or off.

Parameters:

name - The switch name.

on - Whether to turn on or off

Throws:

PowerException

getSwitchNames

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

Gets the list of switch names.

Returns:

The list of names

getFullState

@Command(type=QUERY,
         description="Get the full state")
public QuadBoxState getFullState()

Gets the full quad box state.

Returns:

The full quad box state