org.lsst.ccs.subsystem.pathfinder

Class HexValveMain

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.pathfinder.HexValveMain

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 HexValveMain
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.services.alert.AlertListener

Implements the heat exchanger valve control subsystem.

Author:

Owen Saxton

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

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	connectHex(String hex, String comp) Connect a heat exchanger to a cryo compressor.
List<String>	getCmprNames() Gets a list of the valid compressor names.
List<String>	getHexNames() Gets a list of the valid heat exchanger names.
HexValveState	getSystemState() Gets the state of the hex valve system.
void	onAlert(org.lsst.ccs.services.alert.AlertEvent event) Alert event handler.
void	postInit() Initializes the heat exchanger valve subsystem.
void	postStart() Starts the subsystem.
void	setUpdatePeriod(int value) Sets the monitor update period.
void	setValve(int valve, boolean vstate) set the state of a single valve
String	showValveStates() Show the state of the compressor valves.

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

init, postBuild, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, afterStart, preInit, preShutdown, preStart

Constructor Detail

HexValveMain

public HexValveMain()

Constructor.

Method Detail

build

public void build()

Build phase

Specified by:

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

postInit

public void postInit()

Initializes the heat exchanger valve subsystem.

Specified by:

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

postStart

public void postStart()

Starts the subsystem.

Specified by:

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

getSystemState

@Command(type=QUERY,
         description="Get the hex valve state",
         level=0)
public HexValveState getSystemState()

Gets the state of the hex valve system. This is intended to be called by GUIs during initialization

Returns:

The hex valve state

getHexNames

@Command(type=QUERY,
         description="Get the valid heat exchanger names",
         level=0)
public List<String> getHexNames()

Gets a list of the valid heat exchanger names.

Returns:

The list of names

getCmprNames

@Command(type=QUERY,
         description="Get the valid compressor names",
         level=0)
public List<String> getCmprNames()

Gets a list of the valid compressor names.

Returns:

The list of names

connectHex

@Command(type=ACTION,
         description="Connect hex to compressor")
public void connectHex(@Argument(description="Heat exchanger name")
                                                                                               String hex,
                                                                                               @Argument(description="Compressor name")
                                                                                               String comp)
                                                                                        throws VacuumException

Connect a heat exchanger to a cryo compressor.

Parameters:

hex - The heat exchanger name

comp - The compressor name

Throws:

VacuumException

setValve

@Command(type=ACTION,
         level=10,
         description="set the state of a single valve")
public void setValve(@Argument(description="valve number")
                                                                                                                      int valve,
                                                                                                                      @Argument(description="false=open or true=close")
                                                                                                                      boolean vstate)
                                                                                                               throws VacuumException

set the state of a single valve

Parameters:

valve - number

true - for close. false for open

Throws:

VacuumException

setUpdatePeriod

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

Sets the monitor update period.

Parameters:

value - The 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

showValveStates

@Command(type=ACTION,
         description="report state of valves")
public String showValveStates()
                                                                                            throws VacuumException

Show the state of the compressor valves.

Returns:

compressor valve states

Throws:

VacuumException