org.lsst.ccs.subsystem.airwatch.main

Class AirwatchMain

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.airwatch.main.AirwatchMain

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, org.lsst.ccs.messaging.CommandExecutor, org.lsst.ccs.ServiceLifecycle

public final class AirwatchMain
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler

The main module for the Airwatch subsystem. This module is responsible for:

• Establishing initial contact with the configured instruments.
• Providing and managing the periodic readout task.
• Alert management.
• Location management and status reporting.

* @author tether

Nested Class Summary

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

org.lsst.ccs.Agent.RunningCommand

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

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEW_POINT_KEY
static String	N_DEW_HUMIDS_KEY
static String	N_DEW_TEMPS_KEY

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

Method Summary

Modifier and Type	Method and Description
String	disable(String locName) Suppresses data check alerts for a given location.
String	enable(String locName) Enables data check alerts for a location.
void	init() Checks whether all the subsystem components have been constructed.
String	locations() Gives the status of each of the locations.
void	postStart()
org.lsst.ccs.framework.TreeWalkerDiag	signal(org.lsst.ccs.framework.Signal sig) Signal handler for stop and abort.

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, 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.ClearAlertHandler

canClearAlert

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, postBuild, postInit, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, afterStart, preInit, preShutdown, preStart

Field Detail

N_DEW_TEMPS_KEY

public static final String N_DEW_TEMPS_KEY

See Also:

Constant Field Values

N_DEW_HUMIDS_KEY

public static final String N_DEW_HUMIDS_KEY

See Also:

Constant Field Values

DEW_POINT_KEY

public static final String DEW_POINT_KEY

See Also:

Constant Field Values

Constructor Detail

AirwatchMain

public AirwatchMain()

Constructor.

Method Detail

locations

@Command(type=QUERY,
         description="Displays a short report on location status.",
         level=0)
public String locations()

Gives the status of each of the locations. Includes instrument number, location, enable flag and the timestamp of the last record read.

Returns:

A string with a heading line followed by one line per instrument.

disable

@Command(type=ACTION,
         description="Suppresses data check alerts for a location. Use if the sensor is broken.",
         level=1,
         timeout=120100)
public String disable(@Argument(description="The location name. Case is ignored.")
                                                                                                                                                                                         String locName)
                                                                                                                                                                                  throws Exception

Suppresses data check alerts for a given location. Use if the sensor is broken.

Parameters:

locName - the name of a location. Case is ignored.

Returns:

"OK", or "BUSY" if we timed out waiting for the lock.

Throws:

IllegalArgumentException - if locName is invalid.

Exception

enable

@Command(type=ACTION,
         description="Enables data check alerts for a location.",
         level=1,
         timeout=120100)
public String enable(@Argument(description="The location name. Case is ignored.")
                                                                                                                                                        String locName)
                                                                                                                                                 throws Exception

Enables data check alerts for a location.

Parameters:

locName - the name of a location. Case is ignored.

Returns:

"OK", or "BUSY" if we timed out waiting for the lock.

Throws:

IllegalArgumentException - if locName is invalid.

Exception

signal

public org.lsst.ccs.framework.TreeWalkerDiag signal(org.lsst.ccs.framework.Signal sig)

Signal handler for stop and abort.

Specified by:

signal in interface org.lsst.ccs.framework.SignalHandler

Parameters:

sig - The signal.

Returns:

TreeWalkerDiag.GO.

init

public void init()

Checks whether all the subsystem components have been constructed. Called just after the subsystem component tree has been built.

Specified by:

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

Throws:

Error - if anything is missing.

postStart

public void postStart()

Specified by:

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