org.lsst.ccs.subsystem.power

Class MainPower

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.power.MainPower

All Implemented Interfaces:

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

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

Implements the power supply control subsystem. *** Needs work if to be used again ***

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

Modifier and Type	Field and Description
static String	BROADCAST_TASK

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
MainPower() Constructor

Method Summary

Modifier and Type	Method and Description
void	build() Power subsystem initialization
PowerState	getFullState() Gets the full power state.
Power[]	getPowerConfig() Gets the configuration data.
List<PowerChanState>	getPowerState() Gets the power state.
void	periodicBroadcast() Performs periodic power data broadcast.
void	postInit() Power subsystem post-initialization
void	postStart() Starts the subsystem.
void	powerOff() Turns off the power.
void	powerOn() Turns on the power.
void	saveNamedConfig(String name) Saves the configuration data.
void	setPowerConfig(Power[] power) Sets the configuration data.
void	setUpdatePeriod(int period) Sets the update (tick) period.

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

init, postBuild, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterBuild, afterInit, afterStart, preBuild, preShutdown

Field Detail

BROADCAST_TASK

public static final String BROADCAST_TASK

See Also:

Constant Field Values

Constructor Detail

MainPower

public MainPower()

Constructor

Method Detail

build

public void build()

Power subsystem initialization

Specified by:

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

postInit

public void postInit()

Power 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.

setUpdatePeriod

@Command(type=ACTION,
         description="Set the update period")
public void setUpdatePeriod(int period)

Sets the update (tick) period.

Parameters:

period - The update period (milliseconds) to set.

saveNamedConfig

@Command(type=ACTION,
         description="Save the current configuration")
public void saveNamedConfig(String name)
                                                                                                  throws IOException

Saves the configuration data.

Parameters:

name - The configuration name

Throws:

IOException

getPowerConfig

@Command(type=QUERY,
         description="Get the configuration data")
public Power[] getPowerConfig()

Gets the configuration data.

Returns:

The array of power configuration objects

setPowerConfig

@Command(type=ACTION,
         description="Set the configuration data")
public void setPowerConfig(Power[] power)
                                                                                             throws Exception

Sets the configuration data.

Parameters:

power - The array of power configuration objects

Throws:

Exception

getPowerState

@Command(type=QUERY,
         description="Get the power state")
public List<PowerChanState> getPowerState()
                                                                                                    throws Exception

Gets the power state.

Returns:

The power state

Throws:

Exception

powerOn

@Command(type=ACTION,
         description="Turn on the power")
public void powerOn()
                                                                             throws Exception

Turns on the power.

Throws:

Exception

powerOff

@Command(type=ACTION,
         description="Turn off the power")
public void powerOff()
                                                                               throws Exception

Turns off the power.

Throws:

Exception

getFullState

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

Gets the full power state.

Returns:

The full power state