stella.sensor

Class AverageSensor

java.lang.Object

util.PropertyContainer

util.PropertyResources

util.rmi.RmiPropertyContainer

util.rmi.AbstractRmiCaster

stella.sensor.AbstractSensor

stella.sensor.TimerTaskSensor

stella.sensor.DataSensor

stella.sensor.CumulativeSensor

stella.sensor.PredictiveSensor

stella.sensor.SmoothingSensor

stella.sensor.DerivativeSensor

stella.sensor.WeatherSensor

stella.sensor.AverageSensor

All Implemented Interfaces:

Cloneable, Remote, Caster, DataCaster, RmiDataCaster, RmiErrorCaster, Cumulating, Deriving, Predicting, SensorDepending, Smoothing, Telemetering, WeatherJudging, WeatherCaster, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying, RmiCaster, RmiPropertyBearing

public class AverageSensor
extends WeatherSensor
implements SensorDepending

A class that takes a list of individual sensors and returns the average of their measurements as its measurement. Whenever this sensor is queried for its reading it takes the most recent reading of its registered (CumulativeSensor.KEY_AVERAGE) sensors and returns the average reading. Depending on KEY_OFFSET all readings that are more than this value relatively off the average are discarded. Additionally, readings below or equal KEY_MINTHRESHOLD and readings above or equal KEY_MAXTHRESHOLD are discarded.

Nested Class Summary

Nested classes/interfaces inherited from class stella.sensor.TimerTaskSensor

TimerTaskSensor.SensorRead

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private BufferedWriter	allsensors Write out individual sensor readings.
private Map<Telemetering,Double>	average The list of registered sensors that are used for averaging.
private static int	DEFREPORTLOGMS
static String	KEY_AVERAGEOF The list of the sensor names that are used for averaging.
static String	KEY_DEBUGHEAD First line to write to debug log.
static String	KEY_DEBUGLOG The log file to write individual sensors, debugging mainly.
static String	KEY_MAXTHRESHOLD The maximum value that is considered valid of an individual sensor.
static String	KEY_MINTHRESHOLD The minimum value that is considered valid of an individual sensor.
static String	KEY_OFFSET The maximum offset allowed.
static String	KEY_REPORTLOGMS Re-report after this time-out.
static String	KEY_TRUSTED If variance test fails, only use trusted sensors.
static String	KEY_VARIANCE If the variance exceeds this sigma-value, use only trusted sensors.
static String	MAXIMUM
static String	MINIMUM
private List<String>	names The list of names of the sensors that should be averaged.
private double	wasread Caches the last valid value.
private Date	wasreport Reporting toggle.
private boolean	wasvalid Gets true after startup and a first successful average calculation.

Fields inherited from class stella.sensor.WeatherSensor

KEY_DERIVATIVEINVALID, KEY_DERIVATIVEPARAMETER, KEY_INVERSE, KEY_INVERSEDERIVATIVE, KEY_JUDGEDERIVATIVE, KEY_JUDGEPREDICT, KEY_JUDGERAW, KEY_JUDGESMOOTH, KEY_PREDICTINVALID, KEY_PREDICTPARAMETER, KEY_RAWINVALID, KEY_RAWPARAMETER, KEY_RETARDBADDERIVATIVE, KEY_RETARDBADPREDICT, KEY_RETARDBADRAW, KEY_RETARDBADSMOOTH, KEY_RETARDGOODDERIVATIVE, KEY_RETARDGOODPREDICT, KEY_RETARDGOODRAW, KEY_RETARDGOODSMOOTH, KEY_SMOOTHINVALID, KEY_SMOOTHPARAMETER

Fields inherited from class stella.sensor.DerivativeSensor

DEFRAWDERIVATIVE, derive, KEY_DERIVATIVEADVISE, KEY_DERIVE, KEY_PATH, KEY_RAWDERIVATIVE, z

Fields inherited from class stella.sensor.SmoothingSensor

f, g, KEY_SMOOTH, KEY_SMOOTHADVISE

Fields inherited from class stella.sensor.PredictiveSensor

KEY_CHI, KEY_EXTRAPOLATE, KEY_FUTURE, KEY_PREDICTADVISE, predict

Fields inherited from class stella.sensor.CumulativeSensor

KEY_AVERAGE, KEY_MEMORY, KEY_PACK

Fields inherited from class stella.sensor.DataSensor

DEFRAWFORMAT, DEFREPORT, DEFSIGMAFORMAT, KEY_RAWFORMAT, KEY_REPORT, KEY_SIGMAFORMAT

Fields inherited from class stella.sensor.TimerTaskSensor

KEY_LOGRAWABOVE, KEY_LOGRAWBELOW, KEY_LOGREADLAG, KEY_RESPAWN

Fields inherited from class stella.sensor.AbstractSensor

KEY_BIND, KEY_BINDNAME, KEY_CONVERT, KEY_DESCRIPTION, KEY_SENSORNAME

Fields inherited from class util.rmi.AbstractRmiCaster

ALTERNATEHOST, ALTERNATEPORT, KEY_EXPORTPORT, KEY_REGISTRYHOST, KEY_REGISTRYPORT

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface stella.rmi.RmiDataCaster

NAMING_EXTENSION

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors

Constructor and Description
AverageSensor(Map<String,String> prop) Constructs a new averaging sensor.

Method Summary

Modifier and Type	Method and Description
void	exit() Close the all-sensors log file if present.
private double	getAverage() Calculates the average of the values mapped in the look-up table in a recursive way.
String	getSensorInitInfo() Returns the names of the sensors we use for averaging plus the super information.
void	init() If we have a log file to append to, this is opened here.
private void	openAverageLog() Opens the average sensor log file in append mode.
protected double	readSensor() Reads the averaging sensor.
void	registerSensor(Telemetering add) Adds sensor to this averaging sensor.
private boolean	removeMinMax()
private boolean	removeOffset(double av) Removes all sensors that are above a certain offset.
private boolean	removeVariance(double av, double var)
boolean	validReading() Returns true if the reading of this averaging sensor is true.
private void	writeLog(List<String> sensors, Map<Telemetering,Double> read) For all named sensors in the sensors list, we write their current reading into the open allsensor log file.

Methods inherited from class stella.sensor.WeatherSensor

addWeatherListener, conductOneMeasure, currentlyClear, currentlyRetarding, generateDataEvent, getMinClearUpTime, goodFromDerivative, goodFromPredict, goodFromRaw, goodFromSmooth, isDerivativeRetard, isPredictRetard, isRawRetard, isSmoothRetard, judgeWeather, notifyWeatherListener, removeWeatherListener, status

Methods inherited from class stella.sensor.DerivativeSensor

deriveAt, getDerivativeFormat, getDerivativeToggleInfo, getDerivator, getLastDerivative, isDerivativeAdvise, isDeriving, newData, regetDerive, registerDerivator

Methods inherited from class stella.sensor.SmoothingSensor

getLastSmooth, getSmoother, getSmoothToggleInfo, isSmoothAdvise, isSmoothing, regetSmooth, registerSmoother, smoothOne

Methods inherited from class stella.sensor.PredictiveSensor

getExtrapolation, getLastPredict, getPredictToggleInfo, isPredictAdvise, isPredicting, isReliable, predictFrom, regetPredict

Methods inherited from class stella.sensor.CumulativeSensor

cumulateOne, getLastRaw, getLastTime, getMaxSize, getMemory, getSize

Methods inherited from class stella.sensor.DataSensor

addDataListener, addRmiDataListener, getRawFormat, getSigmaFormat, removeDataListener, removeRmiDataListener, report

Methods inherited from class stella.sensor.TimerTaskSensor

cancel, equals, getRawToggleInfo, getReading, getRespawn, getTimeOfRead, hashCode, initSensorTimerTask, isReady, regetRaw, setTimeOfRead, validReading

Methods inherited from class stella.sensor.AbstractSensor

addRmiErrorListener, createSensor, getBindName, getConvert, getSensorDescription, getSensorName, notifyErrorListener, removeRmiErrorListener, setConvert, toString

Methods inherited from class util.rmi.AbstractRmiCaster

bindToRegistry, bindToRegistry, bindToRegistry, bindToRegistry, bindToRegistry, bindToRegistry, casterExit, casterExit, getBindName, isValid, unbindFromRegistry, unbindFromRegistry

Methods inherited from class util.rmi.RmiPropertyContainer

containsRemoteProperty, getRemoteProperties, getRemoteProperty, setRemoteProperty

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface stella.sensor.Cumulating

cumulateOne, getLastRaw, getLastTime, getMaxSize, getSize, getTimeOfRead, regetRaw

Methods inherited from interface util.rmi.RmiCaster

bindToRegistry, isValid, unbindFromRegistry

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Field Detail

MAXIMUM

public static final String MAXIMUM

See Also:

Constant Field Values

MINIMUM

public static final String MINIMUM

See Also:

Constant Field Values

KEY_AVERAGEOF

public static final String KEY_AVERAGEOF

The list of the sensor names that are used for averaging.

See Also:

Constant Field Values

KEY_OFFSET

public static final String KEY_OFFSET

The maximum offset allowed.

See Also:

Constant Field Values

KEY_VARIANCE

public static final String KEY_VARIANCE

If the variance exceeds this sigma-value, use only trusted sensors.

See Also:

Constant Field Values

KEY_TRUSTED

public static final String KEY_TRUSTED

If variance test fails, only use trusted sensors.

See Also:

Constant Field Values

KEY_MINTHRESHOLD

public static final String KEY_MINTHRESHOLD

The minimum value that is considered valid of an individual sensor.

See Also:

Constant Field Values

KEY_MAXTHRESHOLD

public static final String KEY_MAXTHRESHOLD

The maximum value that is considered valid of an individual sensor.

See Also:

Constant Field Values

KEY_DEBUGLOG

public static final String KEY_DEBUGLOG

The log file to write individual sensors, debugging mainly.

See Also:

Constant Field Values

KEY_DEBUGHEAD

public static final String KEY_DEBUGHEAD

First line to write to debug log.

See Also:

Constant Field Values

KEY_REPORTLOGMS

public static final String KEY_REPORTLOGMS

Re-report after this time-out.

See Also:

Constant Field Values

DEFREPORTLOGMS

private static final int DEFREPORTLOGMS

See Also:

Constant Field Values

names

private final List<String> names

The list of names of the sensors that should be averaged.

average

private final Map<Telemetering,Double> average

The list of registered sensors that are used for averaging.

wasvalid

private boolean wasvalid

Gets true after startup and a first successful average calculation.

wasread

private double wasread

Caches the last valid value.

wasreport

private Date wasreport

Reporting toggle.

allsensors

private BufferedWriter allsensors

Write out individual sensor readings.

Constructor Detail

AverageSensor

public AverageSensor(Map<String,String> prop)
              throws RemoteException

Constructs a new averaging sensor. No keys are defaulted. If in the map handed over the KEY_OFFSET, the KEY_MINTHRESHOLD, and the KEY_MAXTHRESHOLD are not defined, no exclusion of readings is done.

Throws:

RemoteException

Method Detail

init

public void init()
          throws InitException

If we have a log file to append to, this is opened here.

Specified by:

init in interface Initializable

Overrides:

init in class PredictiveSensor

Throws:

InitException

exit

public void exit()

Close the all-sensors log file if present.

Specified by:

exit in interface ExitCleaning

Overrides:

exit in class DataSensor

openAverageLog

private void openAverageLog()
                     throws IOException

Opens the average sensor log file in append mode.

Throws:

IOException

registerSensor

public void registerSensor(Telemetering add)

Adds sensor to this averaging sensor. If the Telemetering instance's name is found in the KEY_AVERAGEOF list, this sensor is added to the sensors average map.

Specified by:

registerSensor in interface SensorDepending

validReading

public boolean validReading()

Returns true if the reading of this averaging sensor is true. In the strict variant, this returns true only if all sensors we average over are valid.

Specified by:

validReading in interface Telemetering

getSensorInitInfo

public String getSensorInitInfo()

Returns the names of the sensors we use for averaging plus the super information.

Specified by:

getSensorInitInfo in interface Telemetering

Overrides:

getSensorInitInfo in class WeatherSensor

readSensor

protected double readSensor()

Reads the averaging sensor. All of the mapped sensors are traversed average, their readings are updated and used for averaging.

Specified by:

readSensor in class TimerTaskSensor

See Also:

ConvertToPhysical

writeLog

private void writeLog(List<String> sensors,
                      Map<Telemetering,Double> read)

For all named sensors in the sensors list, we write their current reading into the open allsensor log file.

Parameters:

sensors -

read -

getAverage

private double getAverage()

Calculates the average of the values mapped in the look-up table in a recursive way. First, all mappings to null are ignored. From the remaining values, an average is calculated. If the KEY_OFFSET key is given, all values are then again traversed and all values outside the relative offset are discarded. If at least one value has been discarded, the averaging is started again.

removeOffset

private boolean removeOffset(double av)

Removes all sensors that are above a certain offset. Works only if n>3.

Parameters:

av -

Returns:

removeVariance

private boolean removeVariance(double av,
                               double var)

removeMinMax

private boolean removeMinMax()