org.lsst.ccs.subsystem.common

Class BinaryOpModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystem.common.BinaryOpModule

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.SignalHandler

Direct Known Subclasses:

Adder

public abstract class BinaryOpModule
extends org.lsst.ccs.framework.Module

A base class for a binary operator. The two input values are updated through observers The class computes periodically the output value using the current input values

Author:

aubourg

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

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

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
protected double	current1
protected double	current2

Fields inherited from class org.lsst.ccs.framework.Module

environment, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
BinaryOpModule()

Method Summary

Modifier and Type	Method and Description
String	getInput1()
String	getInput2()
String	getOutput()
abstract double	op() Computes the output from the current values of the input parameters.
void	processUpdate(Observable source, org.lsst.ccs.framework.Module.ValueUpdate update)
void	setInput1(String input1) The name of input parameter 1, will be checked when update is called.
void	setInput2(String input2) The name of input parameter 2, will be checked when update is called.
void	setOutput(String output) The name used to broadcast the result
void	tick()

Methods inherited from class org.lsst.ccs.framework.Module

alias, getComponentDictionariesTree, getComponentTree, getContext, getEnvironment, getMainDictionary, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, initModule, listens, percolateSignal, postStart, publishData, publishData, publishData, publishData, publishData, publishData, publishData, sendSignal, sendSignal, sendSignalWithTimeLimit, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, setTickMillis, shutdownNow, signal, startTicking, 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

current1

protected double current1

current2

protected double current2

Constructor Detail

BinaryOpModule

public BinaryOpModule()

Method Detail

getInput1

public String getInput1()

setInput1

public void setInput1(String input1)

The name of input parameter 1, will be checked when update is called.

Parameters:

input1 -

getInput2

public String getInput2()

setInput2

public void setInput2(String input2)

The name of input parameter 2, will be checked when update is called.

Parameters:

input2 -

getOutput

public String getOutput()

setOutput

public void setOutput(String output)

The name used to broadcast the result

Parameters:

output -

op

public abstract double op()

Computes the output from the current values of the input parameters. This method has to be overriden by derived class.

Returns:

the result

processUpdate

public void processUpdate(Observable source,
                          org.lsst.ccs.framework.Module.ValueUpdate update)

Overrides:

processUpdate in class org.lsst.ccs.framework.Module

tick

public void tick()

Overrides:

tick in class org.lsst.ccs.framework.Module