org.lsst.ccs.subsystem.pathfinder

Class PathfinderSubsystem

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.pathfinder.PathfinderSubsystem

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.monitor.Monitor.AlarmHandler, org.lsst.ccs.ServiceLifecycle, org.lsst.ccs.services.alert.AlertListener

public class PathfinderSubsystem
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.monitor.Monitor.AlarmHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.services.alert.AlertListener

The PathfinderSubsystem is designed specifically for running ComCam thermal and vacuum control,

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

Fields inherited from interface org.lsst.ccs.monitor.Monitor.AlarmHandler

alarms

Constructor Summary

Constructors

Constructor and Description
PathfinderSubsystem() Main constructor for the PathfinderSubsystem, normally invoked from the corresponding groovy file.

Method Summary

Modifier and Type	Method and Description
void	build()
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(int cond) Clears a latched condition.
void	enableAlertResponse(boolean enable)
List<String>	getSwitchNames() Gets the list of switch names.
VacSysState	getVacuumState() Gets the state of the Vacuum system.
boolean	isAlertResponseEnabled()
boolean	isMonAlertEnabledVATShut()
void	onAlert(org.lsst.ccs.services.alert.AlertEvent event) Alert event handler.
void	postInit()
void	postStart()
boolean	processAlarm(int event, int parm, String cause, String alarmName)
void	setMonAlertEnabledVATShut(boolean enable)
void	setNamedSwitchOn(String name, boolean on) Turns a named switch on or off.
void	setSwitchOn(int sw, boolean on) Turns a switch on or off.
void	setUpdatePeriod(int value) Sets the update period.
void	Sleep(double secs) Sleep - what a waste **************************************************************************

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.monitor.Monitor.AlarmHandler

getAlarmById

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, afterStart, preInit, preShutdown, preStart

Constructor Detail

PathfinderSubsystem

public PathfinderSubsystem()

Main constructor for the PathfinderSubsystem, normally invoked from the corresponding groovy file.

Method Detail

postInit

public void postInit()

Specified by:

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

build

public void build()

Specified by:

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

postStart

public void postStart()

Specified by:

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

processAlarm

public boolean processAlarm(int event,
                            int parm,
                            String cause,
                            String alarmName)

Specified by:

processAlarm in interface org.lsst.ccs.monitor.Monitor.AlarmHandler

Sleep

public void Sleep(double secs)

Sleep - what a waste **************************************************************************

getVacuumState

@Command(type=QUERY,
         description="Get the vacuum system state")
public VacSysState getVacuumState()

Gets the state of the Vacuum system.

Returns:

The vacuum state

getSwitchNames

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

Gets the list of switch names.

Returns:

The switch names.

Throws:

VacuumException

setSwitchOn

@Command(type=ACTION,
         description="Turn on/off a switch")
public void setSwitchOn(@Argument(description="The switch number")
                                                                                           int sw,
                                                                                           @Argument(description="Whether to turn on")
                                                                                           boolean on)
                                                                                    throws VacuumException

Turns a switch on or off.

Parameters:

sw - The switch number.

on - Whether to turn on or off

Throws:

VacuumException

setNamedSwitchOn

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

Turns a named switch on or off.

Parameters:

name - The switch name.

on - Whether to turn on or off

Throws:

VacuumException

clearLatch

@Command(type=ACTION,
         description="Clear a condition")
public void clearLatch(@Argument(description="The condition number")
                                                                                       int cond)
                                                                                throws VacuumException

Clears a latched condition.

Parameters:

cond - The condition number.

Throws:

VacuumException

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.

enableAlertResponse

@Command(type=ACTION,
         description="Enable/disable alert response")
public void enableAlertResponse(boolean enable)

isAlertResponseEnabled

@Command(type=QUERY,
         description="Get true/false if the alert response is enabled")
public boolean isAlertResponseEnabled()

setMonAlertEnabledVATShut

@Command(type=ACTION,
         description="Enable/disable vacuum monitoring VAT shutting action")
public void setMonAlertEnabledVATShut(boolean enable)

isMonAlertEnabledVATShut

@Command(type=QUERY,
         description="Get true/false if the alert response is enabled")
public boolean isMonAlertEnabledVATShut()

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

Specified by:

canClearAlert in interface org.lsst.ccs.monitor.Monitor.AlarmHandler

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