org.lsst.ccs.subsystem.monitor

Class MonMain

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystem.monitor.MonMain

All Implemented Interfaces:

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

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

Implements a monitor-only modular 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
MonMain(String name, int tickMillis, int checkMillis) 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.
MonMainFullState	getFullState() Gets the full state of the monitoring module.
void	initModule() Initializes the subsystem.
void	postStart() Starts the subsystem.
void	saveConfig() Saves the configuration data.
void	setTickMillis(int value) Sets the tick period.
void	tick() Performs periodic trending 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

MonMain

public MonMain(String name,
               int tickMillis,
               int checkMillis)

Main constructor.

Parameters:

name - The subsystem name.

tickMillis - The tick period (ms).

checkMillis - The hardware check period (ms).

Method Detail

initModule

public void initModule()

Initializes the 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 trending 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.

saveConfig

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

Saves the configuration data.

Throws:

IOException

getFullState

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

Gets the full state of the monitoring module. This is intended to be called by GUIs during initialization

Returns:

The full generic monitoring state