org.lsst.ccs.subsystem.utility

Class MpmMain

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.utility.MpmMain

All Implemented Interfaces:

EventListener, org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.CommandExecutor, org.lsst.ccs.ServiceLifecycle, org.lsst.ccs.services.alert.AlertListener

public class MpmMain
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.services.alert.AlertListener

The master protection system

Author:

The LSST CCS Team

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 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
MpmMain()

Method Summary

Modifier and Type	Method and Description
void	build() Build phase
org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode	canClearAlert(org.lsst.ccs.bus.data.Alert alert, org.lsst.ccs.bus.states.AlertState alertState) Callback to clear an Alert instance.
void	clearLatch(String cond) Clears a (named) latched condition.
List<String>	getLatchNames() Gets the list of latched condition names.
List<String>	getSwitchNames() Gets the list of switch names.
MpmSysState	getSystemState() Gets the state of the protection system.
void	onAlert(org.lsst.ccs.services.alert.AlertEvent event) Alert event handler.
void	postInit() Post initialization
void	postStart() Post start
void	setNamedSwitchOn(String swch, boolean on) Turns a (named) switch on or off.
void	setUpdatePeriod(int value) Sets the update period.

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

init, postBuild, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, afterStart, preInit, preShutdown, preStart

Constructor Detail

MpmMain

public MpmMain()

Method Detail

build

public void build()

Build phase

Specified by:

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

postInit

public void postInit()

Post initialization

Specified by:

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

postStart

public void postStart()

Post start

Specified by:

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

getSystemState

@Command(type=QUERY,
         description="Get the protection system state")
public MpmSysState getSystemState()

Gets the state of the protection system.

Returns:

The protection system state

getSwitchNames

@Command(type=QUERY,
         description="Get switch names")
public List<String> getSwitchNames()
                                                                                          throws UtilityException

Gets the list of switch names.

Returns:

The switch names.

Throws:

UtilityException

setNamedSwitchOn

@Command(type=ACTION,
         description="Turn on/off a named switch")
public void setNamedSwitchOn(@Argument(description="The switch name")
                                                                                                      String swch,
                                                                                                      @Argument(description="Whether to turn on")
                                                                                                      boolean on)
                                                                                               throws UtilityException

Turns a (named) switch on or off.

Parameters:

swch - The switch name.

on - Whether to turn on or off

Throws:

UtilityException

getLatchNames

@Command(type=QUERY,
         description="Get latched condition names")
public List<String> getLatchNames()
                                                                                                    throws UtilityException

Gets the list of latched condition names.

Returns:

The condition names.

Throws:

UtilityException

clearLatch

@Command(type=ACTION,
         description="Clear a latched condition")
public void clearLatch(@Argument(description="The condition name")
                                                                                               String cond)
                                                                                        throws UtilityException

Clears a (named) latched condition.

Parameters:

cond - The condition name.

Throws:

UtilityException

setUpdatePeriod

@Command(type=ACTION,
         description="Set the update interval")
public void setUpdatePeriod(@Argument(description="The tick period (ms)")
                                                                                                  int value)

Sets the update period.

Parameters:

value - The update period (milliseconds) to set.

canClearAlert

public org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode canClearAlert(org.lsst.ccs.bus.data.Alert alert,
                                                                             org.lsst.ccs.bus.states.AlertState alertState)

Callback to clear an Alert instance.

Specified by:

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

Parameters:

alert - The Alert instance to clear.

alertState - The AlertState for the provided Alert.

Returns:

A ClearAlertCode to indicate which action is to be taken by the framework.

onAlert

public void onAlert(org.lsst.ccs.services.alert.AlertEvent event)

Alert event handler. Resets PLC latch when corresponding alert is cleared.

Specified by:

onAlert in interface org.lsst.ccs.services.alert.AlertListener

Parameters:

event - The alert event