org.lsst.ccs.framework

Class Module

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

All Implemented Interfaces:

Observer, Configurable, SignalHandler

Direct Known Subclasses:

ConfigurationServerModule, Context, GuardedActuatorForT, RaceConditionCheck, ThermalSystem

public class Module
extends Observable
implements Observer, Configurable, SignalHandler

Building block for a ModularSubsystem. These are Configurable with additional facilities:

• Observable features
• a Timer to publish data at regular intervals
• SignalHandler capabilities (and corresponding commands)
• specific commands

Author:

aubourg

notes: module driver, sends to functionnal modules such as calibration iquestion: how are the module sindependants have a look at sampler ....

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Module.ValueUpdate

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
protected Configurable.Environment	environment
protected static Logger	log
protected String	name
protected int	nObserverThreads
protected int	tickMillis

Constructor Summary

Constructors

Constructor and Description
Module()
Module(int tickMillis)
Module(String name)
Module(String name, int tickMillis)

Method Summary

Modifier and Type	Method and Description
void	alias(String alias) runtime alias for invoking commands.
TreeBranch<DictionaryContext>	getComponentDictionariesTree() publishes a tree where each node associates a component's name with its dictionary
TreeBranch<String>	getComponentTree() publishes a tree of subcomponents' names
Context	getContext() Deprecated.
Configurable.Environment	getEnvironment()
Dictionary	getMainDictionary() published the topmost command dictionary : this is a composite command dictionary that references the main dictionary and the subsystem dictionary.
Module	getModule(String moduleName) Finds a module by name within the same ModularSubsystem
String	getName() get the name of this component
int	getNObserverThreads()
List<Observable>	getObservables()
Subsystem	getSubsystem()
int	getTickMillis()
void	init() this method is called as a "postStart" operation.
void	initModule() To be overriden by individual modules.
void	listens(Observable... observs)
void	percolateSignal(Signal signal) utility method to send a signal to all branches of a component's tree
void	postStart() once all hardware components have been started this method is invoked.
void	processUpdate(Observable source, Module.ValueUpdate update) This method should be overriden to handle change to properties of watched modules
void	publishData(DataValueNotification td) Deprecated.
void	publishData(List<ValueNotification> tdl) Deprecated.
void	publishData(String name, Object value) Deprecated.
void	publishData(String name, Object value, long tStamp) Deprecated.
void	publishData(String name, Serializable value) Deprecated.
void	publishData(String name, Serializable value, long tStamp) Deprecated.
void	publishData(ValueNotification td) Deprecated.
void	sendSignal(long expectedMaxDelay, String signalString) Deprecated.
void	sendSignal(String signalString) command to send a signal.
void	sendSignalWithTimeLimit(String signalString, long expectedMaxDelay) command to send a signal with a delay for execution.
void	sendToReply(CommandReply myReply) Deprecated.
void	sendToStatus(Status status) Deprecated.
void	setBeanName(String n) Deprecated.
void	setContext(Context context) Deprecated.
void	setEnvironment(Configurable.Environment environment) sets the current Environment Object for the Component.
void	setName(String name) Sets the module name.
void	setNObserverThreads(int observerThreads)
void	setObservables(List<Observable> l)
void	setStateModularSubsystem(PublishedState newState) Deprecated.
void	setStateModularSubsystem(PublishedState newState, String extraInfo) Deprecated.
void	setTickMillis(int tickMillis) Changes the periodic wake up time.
void	shutdownNow() added for tying to unstuck ExcecutorService
TreeWalkerDiag	signal(Signal sig) this method is intended for overriding: the module receives an out of band signal.
void	startTicking() If there is a scheduled wake up (that is if the tickMillis is more than zero) then the ticking starts.
void	tick()
void	update(Observable o, Object arg) Synchronous update.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

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

change, getCheckedValueFromConfiguration, getChildren, getComponentByName, getDictionary, getParent, getParentObject, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, proceduralWalk, publish, publish, publish, publish, publish, publish, start, treeWalk

Field Detail

environment

protected Configurable.Environment environment

log

protected static Logger log

name

protected String name

nObserverThreads

protected int nObserverThreads

tickMillis

protected int tickMillis

Constructor Detail

Module

public Module()

Module

public Module(int tickMillis)

Module

public Module(String name,
              int tickMillis)

Module

public Module(String name)

Method Detail

getName

public String getName()

Description copied from interface: Configurable

get the name of this component

Specified by:

getName in interface Configurable

Returns:

the module name

setName

public void setName(String name)

Sets the module name. Called upon module assembly from xml description file. The module name should be unique within a ModularSubsystem

Parameters:

name -

alias

public void alias(String alias)

runtime alias for invoking commands. Note: there is still a duplication of implementation (groovy + xml) but one only should stay!

Specified by:

alias in interface Configurable

Parameters:

alias -

getEnvironment

public Configurable.Environment getEnvironment()

Specified by:

getEnvironment in interface Configurable

Returns:

the "virtual field" Environment.

setEnvironment

public void setEnvironment(Configurable.Environment environment)

Description copied from interface: Configurable

sets the current Environment Object for the Component. this method should be called once by the Subsystem initializaiton process just after the Component constructor has been called (a "PostConstruct" method).

Specified by:

setEnvironment in interface Configurable

setObservables

public void setObservables(List<Observable> l)

listens

public void listens(Observable... observs)

getObservables

public List<Observable> getObservables()

setTickMillis

@ConfigChanger(argNames="tickInterval")
public void setTickMillis(int tickMillis)

Changes the periodic wake up time. The tick method will be called every tickMillis ms.

if called before startup this method just fix the tick frequency (the module wil later "tick" at this rate) .

if called after startup then will change the ticking rate
in that case the ticking will change but new rate will be effective after a delay of "old rate"

Parameters:

tickMillis -

getTickMillis

public int getTickMillis()

setNObserverThreads

public void setNObserverThreads(int observerThreads)

getNObserverThreads

public int getNObserverThreads()

init

public final void init()

Description copied from interface: Configurable

this method is called as a "postStart" operation. if overriden it is highly recommended to invoke super.init().
the actual code performs resource injection: all fields declared in the current class and annotated as Resource are queried from the Environment and their reference initialize the field.

Specified by:

init in interface Configurable

initModule

public void initModule()

To be overriden by individual modules. Called after all parameters have been set from XML file.

getContext

@Deprecated
public Context getContext()

Deprecated.

setContext

@Deprecated
public void setContext(Context context)

Deprecated.

getSubsystem

public Subsystem getSubsystem()

Specified by:

getSubsystem in interface Configurable

Returns:

the current Subsystem in which this object is deployed

getModule

public Module getModule(String moduleName)

Finds a module by name within the same ModularSubsystem

Parameters:

moduleName -

Returns:

the module instance

postStart

public void postStart()
               throws HardwareException

Description copied from interface: Configurable

once all hardware components have been started this method is invoked. it notifies all component that now the subsystem is going to end initialization phase that could be the place to start ticks (module) or to "home" hardwares (that's the reason why this method throws a HardwareException)

Specified by:

postStart in interface Configurable

Throws:

HardwareException

startTicking

public void startTicking()

If there is a scheduled wake up (that is if the tickMillis is more than zero) then the ticking starts. This method is called on every module after the subsystem is itself ready to listen to commands.

update

public void update(Observable o,
                   Object arg)

Synchronous update. Do not override, override processUpdate. Should we make it final?

Specified by:

update in interface Observer

processUpdate

public void processUpdate(Observable source,
                          Module.ValueUpdate update)

This method should be overriden to handle change to properties of watched modules

Parameters:

source - the module

update - the update message, containing property name and new value

tick

public void tick()

setBeanName

@Deprecated
public void setBeanName(String n)

Deprecated.

setStateModularSubsystem

@Deprecated
public void setStateModularSubsystem(PublishedState newState)

Deprecated.

This method change the status of modular subsystem

Parameters:

newState - The new state of the modular subsystem

setStateModularSubsystem

@Deprecated
public void setStateModularSubsystem(PublishedState newState,
                                                 String extraInfo)

Deprecated.

This method change the status of modular subsystem

Parameters:

newState - The new state of the modular subsystem

extraInfo - Can clarify a state, like origin of the error

publishData

@Deprecated
public void publishData(String name,
                                    Object value,
                                    long tStamp)

Deprecated.

publishData

@Deprecated
public void publishData(String name,
                                    Serializable value,
                                    long tStamp)

Deprecated.

publishData

@Deprecated
public void publishData(String name,
                                    Object value)

Deprecated.

publishData

@Deprecated
public void publishData(String name,
                                    Serializable value)

Deprecated.

publishData

@Deprecated
public void publishData(List<ValueNotification> tdl)

Deprecated.

publishData

@Deprecated
public void publishData(ValueNotification td)

Deprecated.

publishData

@Deprecated
public void publishData(DataValueNotification td)

Deprecated.

sendToStatus

@Deprecated
public void sendToStatus(Status status)

Deprecated.

sends status on the status bus

sendToReply

@Deprecated
public void sendToReply(CommandReply myReply)

Deprecated.

Sends message on the reply bus

Parameters:

myReply - : reply objet MODULES SHOULD NOT DO THAT....

shutdownNow

public void shutdownNow()

added for tying to unstuck ExcecutorService

Specified by:

shutdownNow in interface Configurable

signal

public TreeWalkerDiag signal(Signal sig)

this method is intended for overriding: the module receives an out of band signal. Beware this code is executed in a different thread (take care of threading issued when overriding)

Specified by:

signal in interface SignalHandler

Parameters:

sig -

Returns:

one of the TreeWalkerDiag options to tell the subsystem to continue to call this on child components or not.

sendSignal

@Command(description="will propagate signal to Module and its children ",
         type=ABORT)
public void sendSignal(String signalString)

command to send a signal.

Parameters:

signalString - string representing a member of an enum of type SignalLevel

sendSignal

@Command(description="@Deprecated: will propagate signal to Module and its children with  an expected maximum delay",
         type=ABORT)
 @Deprecated
public void sendSignal(long expectedMaxDelay,
                                                                                                                                                                               String signalString)

Deprecated.

command to send a signal with a delay for execution.

Parameters:

expectedMaxDelay -

signalString - string representing a member of an enum of type SignalLevel

sendSignalWithTimeLimit

@Command(description="will propagate signal to Module and its children with  an expected maximum delay",
         type=ABORT)
public void sendSignalWithTimeLimit(String signalString,
                                                                                                                                                                  long expectedMaxDelay)

command to send a signal with a delay for execution.

Parameters:

signalString - string representing a member of an enum of type SignalLevel

expectedMaxDelay -

percolateSignal

public void percolateSignal(Signal signal)

utility method to send a signal to all branches of a component's tree

Parameters:

signal -

getComponentTree

@Command(description="publishes a tree of component names",
         type=QUERY,
         category=SYSTEM)
public TreeBranch<String> getComponentTree()

publishes a tree of subcomponents' names

Returns:

getMainDictionary

@Command(description="publishes the topmost command dictionary",
         type=QUERY,
         category=SYSTEM)
public Dictionary getMainDictionary()

published the topmost command dictionary : this is a composite command dictionary that references the main dictionary and the subsystem dictionary.

Returns:

Throws:

IllegalArgumentException - if the current Module is not the main

getComponentDictionariesTree

@Command(description="publishes a tree of component dictionary",
         type=QUERY,
         category=SYSTEM)
public TreeBranch<DictionaryContext> getComponentDictionariesTree()

publishes a tree where each node associates a component's name with its dictionary

Returns: