org.lsst.ccs.subsystem.doorman.main

Class DoormanMain

java.lang.Object

org.lsst.ccs.subsystem.doorman.main.DoormanMain

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, org.lsst.ccs.UsesSubsystem

public final class DoormanMain
extends Object
implements org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.SignalHandler

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

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

* @author tether

Nested Class Summary

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

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Constructor Summary

Constructors

Constructor and Description
DoormanMain() Constructor.

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode	canClearAlert(org.lsst.ccs.bus.data.Alert alert) Allows all alerts to be cleared unconditionally.
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware() Attempts to start all configured instruments.
void	checkStarted() Checks whether all the instruments are running.
void	checkStopped() Cancels the readout task if that hasn't already been done.
String	disable(int index) Prevents an instrument from being read until further notice.
String	enable(int index) Enables periodic readout for an instrument.
void	init() Checks whether all the subsystem components have been constructed and registers the ClearAlertHandler.
String	instruments() Gives the status of each of the instruments.
void	postStart() Does nothing.
org.lsst.ccs.framework.TreeWalkerDiag	signal(org.lsst.ccs.framework.Signal sig) Signal handler for stop and abort.
void	start() Does nothing.

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

postInit, postShutdown, shutdownNow

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

sendSignal, sendSignalWithTimeLimit

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Constructor Detail

DoormanMain

public DoormanMain()

Constructor.

Method Detail

instruments

@Command(type=QUERY,
         description="Displays a short report on instrument status.")
public String instruments()

Gives the status of each of the instruments. Includes instrument number, 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="Prevents further readout of an instrument")
public String disable(@Argument(description="Instrument index number.")
                                                                                                              int index)
                                                                                                       throws Exception

Prevents an instrument from being read until further notice.

Parameters:

index - An instrument index number.

Returns:

"OK", or "BUSY" if a readout is in progress.

Throws:

Exception - if ident is invalid or ambiguous.

See Also:

#enable(java.lang.String, java.lang.String)

enable

@Command(type=ACTION,
         description="Enables an instrument for readout.")
public String enable(@Argument(description="Instrument index number.")
                                                                                                      int index)
                                                                                               throws Exception

Enables periodic readout for an instrument.

Parameters:

index - An instrument index number.

Returns:

"OK", or "BUSY" if a readout is in progress.

Throws:

IllegalArgumentException - if ident is invalid or ambiguous.

IllegalArgumentException - if newLocation is invalid.

org.lsst.ccs.HardwareException - if device operations fail.

Exception

See Also:

#disable(java.lang.String)

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 and registers the ClearAlertHandler. 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.

start

public void start()

Does nothing. Called at the start of the initialization phase.

Specified by:

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

checkHardware

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

Attempts to start all configured instruments. Called in the middle of the initialization phase after has been called for all configurable components. All instruments are stopped and re-started with correct configurations for their assigned locations.

Specified by:

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

Returns:

TreeWalkerDiag.GO.

Throws:

org.lsst.ccs.HardwareException - if any fail to respond or if any report hardware faults.

checkStarted

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

Checks whether all the instruments are running. Called after checkHardware().

Specified by:

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

Throws:

org.lsst.ccs.HardwareException - if any aren't.

postStart

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

Does nothing. Called at the end of the initialization phase after start() has been called for all configurable components and after checkHardware() and checkStarted() have been called for all hardware controllers.

Specified by:

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

Throws:

org.lsst.ccs.HardwareException - never.

checkStopped

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

Cancels the readout task if that hasn't already been done. The instruments themselves are not stopped and continue to collect data. Called at the beginning of the shutdown phase.

Specified by:

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

Throws:

org.lsst.ccs.HardwareException - if periodic readout can't be stopped.

See Also:

signal(org.lsst.ccs.framework.Signal)

canClearAlert

public org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode canClearAlert(org.lsst.ccs.bus.data.Alert alert)

Allows all alerts to be cleared unconditionally.

Specified by:

canClearAlert in interface org.lsst.ccs.framework.ClearAlertHandler

Parameters:

alert - The particular alert to be cleared.

Returns:

ClearAlertHandler.ClearAlertCode.CLEAR_ALERT