org.lsst.ccs.startup

Class NodeModularSubsystem

java.lang.Object

org.lsst.ccs.Subsystem

org.lsst.ccs.startup.NodeModularSubsystem

All Implemented Interfaces:

CommandExecutor, CommandListener, StatusListener, StatusListens

public class NodeModularSubsystem
extends Subsystem

the top modular subsystem that deals with configuration proxy and lookup service

Author:

bamade

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.Subsystem

Subsystem.DictionarySearchResult, Subsystem.SignalThread, Subsystem.State, Subsystem.StatusBroadcaster

Field Summary

Fields inherited from class org.lsst.ccs.Subsystem

actionMonitor, ancillaryGroup, closing, commandBuilder, commandBusSelector, commandGroup, commandMonitor, configurationProxy, currentSubsystem, fac, forceShutdown, initializing, initThread, innerState, inTestContext, LOCAL_EXECUTION_INFO, locks, log, logBusHandler, signalsMonitor, startInEngineeringMode, statusBroadcasterLock, statusBroadcasterThread, statusBusSelector, waitingForCommandTermination

Constructor Summary

Constructors

Constructor and Description
NodeModularSubsystem(String name, ConfigurationProxy proxy, EffectiveNode topNode)

Method Summary

Modifier and Type	Method and Description
void	abort() forwards a HALT signal to all components (that are signalHandlers)
void	abort(long expectedMaxDelay) same as abort but with a time span.
void	checkAllHardwareStarted() checks if all HardwareControllers have been started
void	checkAllHardwareStopped() checks if all HardwareControllers have been stopped
void	checkHardware() invoke a checkHardware on all HardwareController (except when return diag modifies the path of invocation)
void	doShutdown() invokes the shutdownNow() methods on all components (starting from the top main Module)
void	doStart() invokes the start() methods on all components (starting from the top main Module)
void	dropConfigurationContext() Deprecated. Does not perform an actual rollback
protected LocalCommandDictionary	getCommandBuilder(Object object) to deprecate: invoke configurable.getCommandBuilder instead.
protected Configurable	getCommandDestination(String commandDestination) utility method to find a Component out of a Command destination
ComponentLookupService	getLookup()
List<ViewValue>	getPreOrderComponentList() *
boolean	isSlave() to be overriden : tells if the subsystem execute command (they all do: but these are commands that go further than the standard list of subsystem commands).
void	loadConfiguration() Loads the default configuration if it exists.
void	loadConfiguration(String config) Loads the specified configuration.
void	newConfigurationContext() Deprecated. will be neutralized in 2.0 and 2.1 branches.
void	postStart() invokes the postStart() methods on all components (starting from the top main Module)
void	register(String configurationName, String tag) Deprecated.
void	registerConfiguration(String configurationName) Deprecated. saveConfiguration should be used instead
void	saveConfiguration() Saves the current Configuration.
void	saveConfiguration(String configurationName) Saves a configuration with a new name.
protected Subsystem.DictionarySearchResult	searchForDictionary(Command command) * searches for details of an incoming command
void	stop() same as stop(delay) but with an infinite delay
void	stop(long expectedMaxDelay) forwards a STOP signal to all components (that are signalHandlers)
void	stopAndWait(long expectedMaxDelay) forwards a STOP signal to all components and then checks if all hardwares have been stopped within expectedMaxDelay
void	switchConfiguration(ConfigProfile oldProfile, ConfigProfile newProfile) TODO: modify this code: the quesiton is what is changed between profiles 2 different cases: after engineering modifications and other switches.

Methods inherited from class org.lsst.ccs.Subsystem

addLock, broadcastAlarm, broadcastAlarm, broadcastAlarmClear, broadcastStatus, broadcastStatus, clearAlarms, completeInitialization, createState, executeCommandSingleThread, fillStatus, forceShutdown, getAgentPresenceManager, getAncillaryGroup, getCCSVersions, getCommandBusSelector, getConfiguration, getConfigurationProxy, getCurrentActionThread, getCurrentSubsystemName, getDefaultSelector, getEthHardAddress, getInnerState, getLogger, getMessagingAccess, getName, getNumberCommandThreads, getSoftwareRevision, getStateForPublication, getStatus, getStatusBroadcastPeriod, getStatusBusSelector, getSystemDictionary, getTag, initialisationEndPhase, initLogBusHandler, interruptActionThread, interruptAllRunningCommands, interruptAllSignalThreads, interruptAncillaryThreads, interruptInitThread, isInEngineeringMode, isInTestContext, isListenToStatus, isMaster, isMultithreaded, isStartedInEngineeringMode, lockUpdate, onAck, onCommand, onReply, onStatus, ping, printRunningCommands, publishData, publishData, publishData, publishData, publishData, publishData, publishData, publishMetaData, publishReply, publishStateChange, publishStatus, publishStatus, publishStatus, publishStatus, publishStatus, publishStatus, publishStatusData, publishTrendingStatus, raiseAlarm, rawCommandExecution, registerAsBusMaster, removeLock, removeLogPanicState, searchForDictionary, sendRawStatus, setBusLogHandlerLevel, setCommandBusSelector, setConfigurationProxy, setListenToStatus, setLogFormat, setLogHandlerLevel, setLogLevel, setMultithreaded, setName, setStackTraceDepth, setStatusBroadcastPeriod, setStatusBusSelector, shutdown, start, startStatusBroadcasting, stayAlive, stopStatusBroadcasting, switchToEngineeringMode, switchToErrorState, switchToNormalMode, switchToShutdownState, tryReadyState, updateCurrentSubsystem, updateState, updateState, waitForCommandExecution, waitForReadyState, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeModularSubsystem

public NodeModularSubsystem(String name,
                            ConfigurationProxy proxy,
                            EffectiveNode topNode)

Parameters:

name - should not be empty

proxy - the configuration proxy (local, remote or test)

topNode - node describing the top component (main)

Method Detail

isSlave

public boolean isSlave()

Description copied from class: Subsystem

to be overriden : tells if the subsystem execute command (they all do: but these are commands that go further than the standard list of subsystem commands).

Overrides:

isSlave in class Subsystem

Returns:

getLookup

public ComponentLookupService getLookup()

getPreOrderComponentList

public List<ViewValue> getPreOrderComponentList()

*

Returns:

a List of [name-component] in PreOrder.

doStart

public void doStart()

invokes the start() methods on all components (starting from the top main Module)

Overrides:

doStart in class Subsystem

postStart

public void postStart()
               throws HardwareException

invokes the postStart() methods on all components (starting from the top main Module)

Overrides:

postStart in class Subsystem

Throws:

HardwareException - because some "homing" operations may be tried by the hardware

doShutdown

public void doShutdown()

invokes the shutdownNow() methods on all components (starting from the top main Module)

Overrides:

doShutdown in class Subsystem

getCommandDestination

protected Configurable getCommandDestination(String commandDestination)

utility method to find a Component out of a Command destination

Parameters:

commandDestination -

Returns:

getCommandBuilder

protected LocalCommandDictionary getCommandBuilder(Object object)

to deprecate: invoke configurable.getCommandBuilder instead.

Overrides:

getCommandBuilder in class Subsystem

Parameters:

object -

Returns:

searchForDictionary

protected Subsystem.DictionarySearchResult searchForDictionary(Command command)
                                                        throws CommandInvocationException

* searches for details of an incoming command

This method is overriden to deal with Modular subsystem

Overrides:

searchForDictionary in class Subsystem

Parameters:

command -

Returns:

Throws:

CommandInvocationException

abort

@Command(description="halt",
         type=ABORT)
public void abort()

forwards a HALT signal to all components (that are signalHandlers)

Overrides:

abort in class Subsystem

abort

@Command(description="halt with expected max delay",
         type=ABORT)
public void abort(long expectedMaxDelay)

same as abort but with a time span.

Overrides:

abort in class Subsystem

Parameters:

expectedMaxDelay -

stop

@Command(description="stops with expected max delay",
         type=ACTION)
public void stop(long expectedMaxDelay)
                                                                                      throws HardwareException

forwards a STOP signal to all components (that are signalHandlers)

Overrides:

stop in class Subsystem

Parameters:

expectedMaxDelay - time limit for execution

Throws:

HardwareException

stop

@Command(description="stops hardware",
         type=ACTION)
public void stop()
                                                                       throws HardwareException

same as stop(delay) but with an infinite delay

Throws:

HardwareException

stopAndWait

@Command(description="waits until all the hardware devices are actually stopped",
         type=ACTION)
public void stopAndWait(long expectedMaxDelay)
                                                                                                                         throws HardwareException,
                                                                                                                                InterruptedException

forwards a STOP signal to all components and then checks if all hardwares have been stopped within expectedMaxDelay

Parameters:

expectedMaxDelay -

Throws:

HardwareException, - InterruptedException

HardwareException

InterruptedException

checkHardware

public void checkHardware()
                   throws HardwareException

invoke a checkHardware on all HardwareController (except when return diag modifies the path of invocation)

Overrides:

checkHardware in class Subsystem

Throws:

HardwareException - a list of HardwareException

checkAllHardwareStarted

public void checkAllHardwareStarted()
                             throws HardwareException

checks if all HardwareControllers have been started

Overrides:

checkAllHardwareStarted in class Subsystem

Throws:

HardwareException - a list of exception fired by hardware that are not started

checkAllHardwareStopped

public void checkAllHardwareStopped()
                             throws HardwareException

checks if all HardwareControllers have been stopped

Overrides:

checkAllHardwareStopped in class Subsystem

Throws:

HardwareException - a list of exception fired by hardware that are not stopped

newConfigurationContext

@Deprecated
 @Command(description="will create a new context for modifying parameters (engineering mode)",
         type=ACTION)
public final void newConfigurationContext()

Deprecated. will be neutralized in 2.0 and 2.1 branches.

starts a new Configuration modification context, switches state to Engineering mode. the new context will end when it will be saved or dropped.

register

@Command(description="@Deprecated: registers a new configuration with name and tag",
         type=CONFIGURATION)
 @Deprecated
public final void register(@Argument(name="configurationName",description="The Name of the Configuration")
                                                                                                                                                          String configurationName,
                                                                                                                                                          @Argument(name="tag",description="The new tag name",defaultValue="")
                                                                                                                                                          String tag)
                                                                                                                                                   throws IOException

Deprecated.

register a new Configuration . the state remains in Engineering mode (though the current context is dropped)

Parameters:

configurationName -

tag -

Throws:

IOException

registerConfiguration

@Deprecated
 @Command(description="registers a new configuration with a name",
         type=CONFIGURATION)
public final void registerConfiguration(@Argument(name="configurationName",description="The Name of the Configuration")
                                                                                                                                                    String configurationName)
                                                                                                                                             throws IOException

Deprecated. saveConfiguration should be used instead

Parameters:

configurationName -

Throws:

IOException

saveConfiguration

@Command(description="Saves a new configuration with a name",
         type=CONFIGURATION)
public final void saveConfiguration(@Argument(name="configurationName",description="The Name of the Configuration")
                                                                                                                               String configurationName)
                                                                                                                        throws IOException

Saves a configuration with a new name. If a configuration with the same name already exists it is overwritten. The state remains in engineering mode.

Parameters:

configurationName - the new configuration name

Throws:

IOException

saveConfiguration

@Command(description="Overwrites the current configuration",
         type=CONFIGURATION)
public final void saveConfiguration()
                                                                                                                       throws IOException

Saves the current Configuration. The state remains in engineering mode

Throws:

IOException

dropConfigurationContext

@Command(description="will drop context for modifying parameters (engineering mode)",
         type=CONFIGURATION)
public void dropConfigurationContext()

Deprecated. Does not perform an actual rollback

drops the current modification of parameters: parameters that were active before the configuration context set up are resurected. Note that the state is still ENGINEERING

loadConfiguration

@Command(description="loads a new configuration with a name",
         type=CONFIGURATION)
public void loadConfiguration(@Argument(name="configurationName",description="The Name of the Configuration")
                                                                                                                         String config)
                                                                                                                  throws Exception

Loads the specified configuration. Parameters listed in the properties file are changed to their new value. Parameters that are not listed are set back to their value defined by the groovy description file Changes that are unsaved are dropped.

Parameters:

config - The name of the configuration

Throws:

IllegalArgumentException - if the argument is a path or if it does not match to an existing configuration file (except when loading the default configuration).

Exception

loadConfiguration

@Command(description="loads the default configuration",
         type=CONFIGURATION)
public void loadConfiguration()
                                                                                                            throws Exception

Loads the default configuration if it exists. If not, all parameters are set back to the value defined in the groovy description file. Equivalent to loadConfiguration("")

Throws:

Exception

switchConfiguration

public void switchConfiguration(ConfigProfile oldProfile,
                                ConfigProfile newProfile)
                         throws Exception

TODO: modify this code: the quesiton is what is changed between profiles 2 different cases: after engineering modifications and other switches.

Parameters:

oldProfile - profile still active in database

newProfile - profile to be registered afterwards

Throws:

Exception - could be that a parameter change is refused by code or that rollback failed afterwards