tsdb.component

Class Sensor

java.lang.Object

tsdb.component.Sensor

All Implemented Interfaces:

java.io.Serializable

public class Sensor
extends java.lang.Object
implements java.io.Serializable

This class contains metadata that is associated with a sensor.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
SensorCategory	category
java.lang.String[]	dependency
java.lang.String	description
java.lang.Float	empiricalDiff maximum difference of empirical value, may be null if not used.
boolean	internal
double	maxInterpolationMSE
java.lang.String	name parameter name of this sensor
float	physicalMax physical maximum
float	physicalMin physical minimum
java.lang.String	post_day_func
java.lang.String	post_hour_func
java.lang.String[]	raw_source
float	stepMax maximum change within a base aggregation time interval
float	stepMin minimal change within a base aggregation time interval
java.lang.String	unitDescription
boolean	useInterpolation fill gaps in time series of this sensor

Constructor Summary

Constructors

Constructor and Description
Sensor(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	checkPhysicalRange(float value) checks if value is in physical range
boolean	checkStepRange(float prevValue, float value) precondition: prevValue and value are valid (no NaN values)
boolean	equals(java.lang.Object obj)
AggregationType	getAggregationDay()
AggregationType	getAggregationHour()
AggregationType	getAggregationMonth()
AggregationType	getAggregationWeek()
AggregationType	getAggregationYear()
java.lang.Float	getEmpiricalDiff()
double	getMaxInterpolationMSE()
java.lang.String	getName()
float	getPhysicalMax()
float	getPhysicalMin()
float	getStepMax()
float	getStepMin()
int	hashCode()
boolean	isAggregable()
boolean	isDerived()
static Sensor	ofYaml(java.lang.String sensorName, YamlMap yamlMap)
void	setAggregationDay(AggregationType agg)
void	setAggregationHour(AggregationType agg)
void	setAggregationMonth(AggregationType agg)
void	setAggregationWeek(AggregationType agg)
void	setAggregationYear(AggregationType agg)
void	setAllAggregations(AggregationType agg)

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

parameter name of this sensor

physicalMin

public float physicalMin

physical minimum

physicalMax

public float physicalMax

physical maximum

stepMin

public float stepMin

minimal change within a base aggregation time interval

stepMax

public float stepMax

maximum change within a base aggregation time interval

useInterpolation

public boolean useInterpolation

fill gaps in time series of this sensor

empiricalDiff

public java.lang.Float empiricalDiff

maximum difference of empirical value, may be null if not used.

description

public java.lang.String description

unitDescription

public java.lang.String unitDescription

category

public SensorCategory category

internal

public boolean internal

maxInterpolationMSE

public double maxInterpolationMSE

raw_source

public java.lang.String[] raw_source

dependency

public java.lang.String[] dependency

post_hour_func

public java.lang.String post_hour_func

post_day_func

public java.lang.String post_day_func

Constructor Detail

Sensor

public Sensor(java.lang.String name)

Method Detail

checkPhysicalRange

public boolean checkPhysicalRange(float value)

checks if value is in physical range

Parameters:

value - value == NaN ==> false

Returns:

if false value should not be included in further processing

checkStepRange

public boolean checkStepRange(float prevValue,
                              float value)

precondition: prevValue and value are valid (no NaN values)

Parameters:

prevValue -

value -

Returns:

getName

public java.lang.String getName()

getPhysicalMin

public float getPhysicalMin()

getPhysicalMax

public float getPhysicalMax()

getStepMin

public float getStepMin()

getStepMax

public float getStepMax()

getEmpiricalDiff

public java.lang.Float getEmpiricalDiff()

isAggregable

public boolean isAggregable()

getMaxInterpolationMSE

public double getMaxInterpolationMSE()

ofYaml

public static Sensor ofYaml(java.lang.String sensorName,
                            YamlMap yamlMap)

getAggregationHour

public AggregationType getAggregationHour()

getAggregationDay

public AggregationType getAggregationDay()

getAggregationWeek

public AggregationType getAggregationWeek()

getAggregationMonth

public AggregationType getAggregationMonth()

getAggregationYear

public AggregationType getAggregationYear()

setAllAggregations

public void setAllAggregations(AggregationType agg)

setAggregationHour

public void setAggregationHour(AggregationType agg)

setAggregationDay

public void setAggregationDay(AggregationType agg)

setAggregationWeek

public void setAggregationWeek(AggregationType agg)

setAggregationMonth

public void setAggregationMonth(AggregationType agg)

setAggregationYear

public void setAggregationYear(AggregationType agg)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isDerived

public boolean isDerived()