org.lsst.ccs.subsystem.teststand.limits

Class LimitAlgorithm

java.lang.Object

org.lsst.ccs.subsystem.teststand.limits.LimitAlgorithm

public abstract class LimitAlgorithm
extends Object

A base class for all limit algorithms.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
LimitAlgorithm()

Method Summary

Modifier and Type	Method and Description
abstract void	adjust(double currentValue, LimitsInterface limits) Optional method which adjust the limits relative to the current value of the item being monitored.
LimitsInterface	getInitialLimits()
double	getInitialValue()
LimitsInterface	getTargetLimits()
double	getTargetValue()
void	init(List<Double> parameters, double initialValue, LimitsInterface initialLimits, double targetValue, LimitsInterface targetLimits) Initialize the algorithm

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitAlgorithm

public LimitAlgorithm()

Method Detail

init

public void init(List<Double> parameters,
                 double initialValue,
                 LimitsInterface initialLimits,
                 double targetValue,
                 LimitsInterface targetLimits)

Initialize the algorithm

Parameters:

parameters - The algorithm specific limit parameters

initialValue - The initial value

initialLimits - The initial limits interface, used for setting limits

targetValue - The target value for the algorithm. Some algorithms use this for computing the limits (e.g. DeltaLimitAlgorithm).

targetLimits - The limits at target.

getInitialLimits

public LimitsInterface getInitialLimits()

getTargetLimits

public LimitsInterface getTargetLimits()

getTargetValue

public double getTargetValue()

getInitialValue

public double getInitialValue()

adjust

public abstract void adjust(double currentValue,
                            LimitsInterface limits)

Optional method which adjust the limits relative to the current value of the item being monitored.

Parameters:

currentValue -