org.lsst.ccs.subsystem.common

Class ConfiguredAverageChannel

java.lang.Object

org.lsst.ccs.monitor.Channel

org.lsst.ccs.monitor.DerivedChannel

org.lsst.ccs.subsystem.common.ConfiguredAverageChannel

All Implemented Interfaces:

org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.config.HasConfigurationParameterDescription, org.lsst.ccs.framework.HasLifecycle

public class ConfiguredAverageChannel
extends org.lsst.ccs.monitor.DerivedChannel

A derived Channel averaging a configuragle list of other Channels with configurable weights

Author:

eisner

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	chanNames
protected List<Double>	chanWeights
protected boolean	ignoreNaN

Fields inherited from class org.lsst.ccs.monitor.Channel

alarmHi, alarmHiA, alarmLo, alarmLoA, checkHi, checkLo, description, devcName, doNotPublish, doNotTrend, format, hwChan, hysteresis, limitHi, limitLo, offset, pageId, scale, subtype, type, TYPE_DIFF, TYPE_POWER, TYPE_PROD, TYPE_QUOT, TYPE_SUM, TYPE_SWITCH, TYPE_TEMP, TYPE_UNKNOWN, TYPE_VOLTS, typeI, units, warnHi, warnLo

Constructor Summary

Constructors

Constructor and Description
ConfiguredAverageChannel()

Method Summary

Modifier and Type	Method and Description
double	evaluateDerivedValue() Evaluate weighted average of specified channel values.
void	setParameterBulk(Map<String,Object> params) Set configuration parameters to new values.
void	validateBulkChange(Map<String,Object> params) Checks validity of a proposed set of ConfigurationParameters The Channel name and weight arrays must have same length,.

Methods inherited from class org.lsst.ccs.monitor.Channel

build, convertRawValue, getConfigurationParameterDescription, getDescription, getDevice, getFormat, getGroup, getHwChan, getHysteresisLimitHi, getHysteresisLimitLo, getHysteresisWarnHi, getHysteresisWarnLo, getId, getLastMeasurement, getLimitHi, getLimitLo, getName, getPageId, getPath, getSubType, getSubTypeStr, getType, getTypeStr, getUnits, getValue, getWarnHi, getWarnLo, hasHysteresis, init, readValue

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

postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

chanNames

@ConfigurationParameter(name="chanNames",
                        category="General",
                        description="Path regular expression to select the Channels to be averaged",
                        maxLength=25,
                        units="unitless")
protected volatile List<String> chanNames

chanWeights

@ConfigurationParameter(name="chanWeights",
                        category="General",
                        description="Weights of Channels to be averaged",
                        maxLength=25,
                        units="unitless")
protected volatile List<Double> chanWeights

ignoreNaN

@ConfigurationParameter(name="ignoreNaN",
                        category="General",
                        isFinal=true,
                        units="unitless",
                        description="if true ignore (omit) NaN channels")
protected volatile boolean ignoreNaN

Constructor Detail

ConfiguredAverageChannel

public ConfiguredAverageChannel()

Method Detail

validateBulkChange

public void validateBulkChange(Map<String,Object> params)

Checks validity of a proposed set of ConfigurationParameters The Channel name and weight arrays must have same length,. Channels must be found on tree. Weights must be positive-definite.

Specified by:

validateBulkChange in interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

Overrides:

validateBulkChange in class org.lsst.ccs.monitor.Channel

Parameters:

Map - of ConfigurationParameters from name to value

setParameterBulk

public void setParameterBulk(Map<String,Object> params)

Set configuration parameters to new values. Checks input Map for those ConfigurationParameters which correspond to hardware settings; the others are left for framework to deal with.

Specified by:

setParameterBulk in interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

Overrides:

setParameterBulk in class org.lsst.ccs.monitor.Channel

Parameters:

Map - of parameters for which a change is requested, keyed by names

evaluateDerivedValue

public double evaluateDerivedValue()

Evaluate weighted average of specified channel values.

Specified by:

evaluateDerivedValue in class org.lsst.ccs.monitor.DerivedChannel

Returns:

double average (NaN if any input value is NaN)