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() Subsystem initialization.
QuadBoxState	getFullState() Gets the full quad box state.
List<String>	getSwitchNames() Gets the list of switch names.
void	periodicBroadcast() Performs periodic power data broadcast.
void	postInit() Subsystem post-initialization
void	postStart() Starts the subsystem.
void	setNamedSwitchOn(String name, boolean on) Turns a named switch on or off.
void	setSwitchOn(int sw, boolean on) Turns a switch on or off.
void	setUpdatePeriod(int period) Sets the update (tick) 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.ServiceLifecycle

afterInit, preShutdown, preStart

Constructor Detail

QuadBox

public QuadBox()

Constructor.

Method Detail

build

public void build()

Subsystem initialization.

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

periodicBroadcast

public void periodicBroadcast()

Performs periodic power data broadcast.

setSwitchOn

@Command(type=ACTION,
         description="Turn on/off a switch")
public void setSwitchOn(@Argument(description="The switch number")
                                                                                           int sw,
                                                                                           @Argument(description="Whether to turn on")
                                                                                           boolean on)
                                                                                    throws PowerException

Turns a switch on or off.

Parameters:

sw - The switch number.

on - Whether to turn on or off

Throws:

PowerException

setNamedSwitchOn

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

Turns a named 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

setUpdatePeriod

@Command(type=ACTION,
         description="Set the update period")
public void setUpdatePeriod(@Argument(name="period",description="The tick period (msecs)")
                                                                                                int period)

Sets the update (tick) period.

Parameters:

period - The update period (milliseconds) to set.

getFullState

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

Gets the full quad box state.

Returns:

The full quad box state

Throws:

PowerException