org.lsst.ccs.subsystem.utility

Class UtilTrunkMain

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.utility.UtilTrunkMain

All Implemented Interfaces:

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

public class UtilTrunkMain
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.ClearAlertHandler

Implements the utility trunk 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
UtilTrunkMain() 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.
List<String>	getFanNames() Gets the list of fan names.
UtilTrunkState	getFullState() Gets the subsystem state.
List<String>	getHeaterNames() Gets the list of heater names.
List<String>	getValveNames() Gets the list of valve names.
void	postInit() Subsystem post-initialization
void	postStart() Starts the subsystem.
void	setFanDeltaTemp(String name, double temp) Sets a fan delta temperature (using its name).
void	setFanSpeed(String name, double speed) Sets a fan speed (using its name).
void	setFanState(String name, FanState state) Sets a fan state (using its name).
void	setHeaterState(String name, HeaterState state) Sets a heater control state (using its name).
void	setHeaterValue(String name, double value) Sets a heater value (using its name).
void	setValvePosition(String name, double position) Sets a valve position (using its name).
void	setValveState(String name, ValveState state) Sets a valve state (using its name).
void	setVpcState(VpcControlState state) Sets the VPC control state.

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

UtilTrunkMain

public UtilTrunkMain()

Constructor.

Method Detail

build

public void build()

Build phase

Specified by:

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

postInit

public void postInit()

Subsystem post-initialization

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

getFullState

@Command(type=QUERY,
         description="Get the full state")
public UtilTrunkState getFullState()

Gets the subsystem state.

Returns:

The full PDU system state

getFanNames

@Command(type=QUERY,
         description="Get list of fan names")
public List<String> getFanNames()

Gets the list of fan names.

Returns:

The list of names

setFanState

@Command(type=ACTION,
         description="Set a fan control state")
public void setFanState(@Argument(description="The fan name")
                                                                                              String name,
                                                                                              @Argument(description="The control state")
                                                                                              FanState state)
                                                                                       throws UtilityException

Sets a fan state (using its name).

Parameters:

name - The fan name

state - The state to set

Throws:

UtilityException

setFanSpeed

@Command(type=ACTION,
         description="Set a fan speed")
public void setFanSpeed(@Argument(description="The fan name")
                                                                                      String name,
                                                                                      @Argument(description="The fan speed")
                                                                                      double speed)
                                                                               throws UtilityException

Sets a fan speed (using its name).

Parameters:

name - The fan name

speed - The fan speed

Throws:

UtilityException

setVpcState

@Command(type=ACTION,
         description="Set the VPC control state")
public void setVpcState(@Argument(description="The control state")
                                                                                                VpcControlState state)
                                                                                         throws UtilityException

Sets the VPC control state.

Parameters:

state - The state to set

Throws:

UtilityException

getHeaterNames

@Command(type=QUERY,
         description="Get list of heater names")
public List<String> getHeaterNames()

Gets the list of heater names.

Returns:

The list of names

setHeaterState

@Command(type=ACTION,
         description="Set a heater control state")
public void setHeaterState(@Argument(description="The heater name")
                                                                                                    String name,
                                                                                                    @Argument(description="The control state")
                                                                                                    HeaterState state)
                                                                                             throws UtilityException

Sets a heater control state (using its name).

Parameters:

name - The heater name

state - The state to set

Throws:

UtilityException

setHeaterValue

@Command(type=ACTION,
         description="Set a heater power")
public void setHeaterValue(@Argument(description="The heater name")
                                                                                            String name,
                                                                                            @Argument(description="The value")
                                                                                            double value)
                                                                                     throws UtilityException

Sets a heater value (using its name).

Parameters:

name - The heater name

value - The heater value (power duty cycle or delta temperature)

Throws:

UtilityException

getValveNames

@Command(type=QUERY,
         description="Get list of valve names")
public List<String> getValveNames()

Gets the list of valve names.

Returns:

The list of names

setValveState

@Command(type=ACTION,
         description="Set a valve control state")
public void setValveState(@Argument(description="The valve name")
                                                                                                  String name,
                                                                                                  @Argument(description="The control state")
                                                                                                  ValveState state)
                                                                                           throws UtilityException

Sets a valve state (using its name).

Parameters:

name - The valve name

state - The state to set

Throws:

UtilityException

setValvePosition

@Command(type=ACTION,
         description="Set a valve position")
public void setValvePosition(@Argument(description="The valve name")
                                                                                                String name,
                                                                                                @Argument(description="The valve position")
                                                                                                double position)
                                                                                         throws UtilityException

Sets a valve position (using its name).

Parameters:

name - The valve name

position - The valve position

Throws:

UtilityException

setFanDeltaTemp

@Command(type=ACTION,
         description="Set a delta temperature")
public void setFanDeltaTemp(@Argument(description="The fan name")
                                                                                                  String name,
                                                                                                  @Argument(description="The delta temperature")
                                                                                                  double temp)
                                                                                           throws UtilityException

Sets a fan delta temperature (using its name).

Parameters:

name - The fan name

temp - The delta temperature to set

Throws:

UtilityException

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

Overrides:

canClearAlert in class org.lsst.ccs.Agent

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.