org.lsst.ccs.subsystem.power

Class MainPower

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystem.power.MainPower

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.SignalHandler

public class MainPower
extends org.lsst.ccs.framework.Module
implements org.lsst.ccs.framework.HardwareController

Implements the power control subsystem.

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

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

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields inherited from class org.lsst.ccs.framework.Module

environment, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
MainPower(String name, int tickMillis, int monMillis) Main constructor.

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware() Initializes the hardware.
void	checkStarted() Checks whether hardware is started.
void	checkStopped() Checks whether hardware is stopped.
PowerFullState	getFullState() Gets the full power state.
Power[]	getPowerConfig() Gets the configuration data.
List<PowerChanState>	getPowerState() Gets the power state.
void	initModule() Initializes the power subsystem.
void	postStart() Starts the subsystem.
void	powerOff() Turns off the power.
void	powerOn() Turns on the power.
void	quit() Terminates the program.
void	saveNamedConfig(String name) Saves the configuration data.
void	setPowerConfig(Power[] power) Sets the configuration data.
void	setTickMillis(int value) Sets the tick period.
void	tick() Performs periodic power data broadcast.

Methods inherited from class org.lsst.ccs.framework.Module

getComponentTree, getEnvironment, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, processUpdate, sendSignal, sendSignalWithTimeLimit, setEnvironment, setName, setNObserverThreads, setObservables, shutdownNow, signal, startTicking, update

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

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

change, dropSubmittedChanges, getCheckedValueFromConfiguration, getChildren, getComponentByName, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, notifyChange, notifyChangeWithoutPreliminaryChecks, printConfigurableParameters, setBulkParameter, start, submitChange, submitChanges, validateBulkChange

Constructor Detail

MainPower

public MainPower(String name,
                 int tickMillis,
                 int monMillis)

Main constructor.

Parameters:

name - The subsystem name.

tickMillis - The tick period (ms).

monMillis - The monitor period (ms).

Method Detail

initModule

public void initModule()

Initializes the power subsystem.

Overrides:

initModule in class org.lsst.ccs.framework.Module

checkHardware

public org.lsst.ccs.framework.TreeWalkerDiag checkHardware()

Initializes the hardware.

Specified by:

checkHardware in interface org.lsst.ccs.framework.HardwareController

Returns:

GO

checkStarted

public void checkStarted()

Checks whether hardware is started.

Specified by:

checkStarted in interface org.lsst.ccs.framework.HardwareController

checkStopped

public void checkStopped()

Checks whether hardware is stopped.

Specified by:

checkStopped in interface org.lsst.ccs.framework.HardwareController

postStart

public void postStart()
               throws org.lsst.ccs.HardwareException

Starts the subsystem.

Specified by:

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

Overrides:

postStart in class org.lsst.ccs.framework.Module

Throws:

org.lsst.ccs.HardwareException

tick

public void tick()

Performs periodic power data broadcast.

Overrides:

tick in class org.lsst.ccs.framework.Module

setTickMillis

@Command(type=ACTION,
         description="Set the tick interval")
public void setTickMillis(int value)

Sets the tick period. Overrides the method in Module in order to publish a status update.

Overrides:

setTickMillis in class org.lsst.ccs.framework.Module

Parameters:

value - The tick 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 PowerFullState getFullState()
                                                                                            throws Exception

Gets the full power state.

Returns:

The full power state

Throws:

Exception

quit

@Command(type=ACTION,
         description="Terminate the program")
public void quit()

Terminates the program.