de.fzi.power.interpreter.calculators.energy

Class AbstractCumulativeEnergyCalculator

java.lang.Object

de.fzi.power.interpreter.calculators.energy.AbstractCumulativeEnergyCalculator

Direct Known Subclasses:

SimpsonRuleCumulativeEnergyCalculator

public abstract class AbstractCumulativeEnergyCalculator
extends Object

This abstract class is designed to be the base class of all algorithms that calculate cumulative energy consumptions based on power consumption samples (sampling points), i.e., in an integrator-like fashion. Usually, inheriting subclasses will implement certain numerical algorithms for integration of time series.

Author:

Florian Rosenthal

Method Summary

Modifier and Type	Method and Description
org.jscience.physics.amount.Amount<javax.measure.quantity.Energy>	calculateNext(javax.measure.Measurable<javax.measure.quantity.Power> newPowerSample) Calculates the next energy sample, i.e., the next integration step is done.
static javax.measure.unit.Unit<javax.measure.quantity.Energy>	getDefaultResultUnit() Gets the energy unit which is used by default.
org.jscience.physics.amount.Amount<javax.measure.quantity.Duration>	getInitialOffset() Gets the initial offset.
javax.measure.unit.Unit<javax.measure.quantity.Energy>	getResultUnit() Gets the unit in which the calculated energy samples are expressed.
org.jscience.physics.amount.Amount<javax.measure.quantity.Duration>	getSamplingPeriod() Gets the current sampling period, i.e, the temporal difference between two consecutive power samples.
void	reset() Resets the state of this instance.
void	setOffset(javax.measure.Measurable<javax.measure.quantity.Duration> initialOffset) Sets the initial offset, i.e., the temporal offset of the first power sample.
void	setSamplingPeriod(javax.measure.Measurable<javax.measure.quantity.Duration> samplingPeriod) Sets the sampling period, i.e., the temporal difference between the next consecutive power samples.

Methods inherited from class java.lang.Object

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

Method Detail

reset

public void reset()

Resets the state of this instance. In particular, the initial offset is set to 0s, the sampling period is set to default (10s) and all so far calculated energy samples are discarded. Additionally, all power samples kept for calculation are cleared.

setSamplingPeriod

public void setSamplingPeriod(javax.measure.Measurable<javax.measure.quantity.Duration> samplingPeriod)

Sets the sampling period, i.e., the temporal difference between the next consecutive power samples. This might be useful if the sampling points are not equidistant.

Parameters:

samplingPeriod - A Measurable denoting the sampling period, i.e., the temporal difference between two consecutive power samples.

Throws:

IllegalArgumentException - In case the given duration is null or not positive

setOffset

public void setOffset(javax.measure.Measurable<javax.measure.quantity.Duration> initialOffset)

Sets the initial offset, i.e., the temporal offset of the first power sample.

Parameters:

initialOffset - A Measurable denoting the temporal offset, i.e., the point in time it was taken.

Throws:

IllegalArgumentException - In case initialOffset is null or negative

getInitialOffset

public org.jscience.physics.amount.Amount<javax.measure.quantity.Duration> getInitialOffset()

Gets the initial offset.

Returns:

An Amount denoting the temporal offset of the first sampling point/power sample.

getSamplingPeriod

public org.jscience.physics.amount.Amount<javax.measure.quantity.Duration> getSamplingPeriod()

Gets the current sampling period, i.e, the temporal difference between two consecutive power samples.

Returns:

An Amount denoting the sampling period.

getResultUnit

public javax.measure.unit.Unit<javax.measure.quantity.Energy> getResultUnit()

Gets the unit in which the calculated energy samples are expressed.

Returns:

An Unit denoting an energy unit.

getDefaultResultUnit

public static javax.measure.unit.Unit<javax.measure.quantity.Energy> getDefaultResultUnit()

Gets the energy unit which is used by default.

Returns:

A Unit denoting Wh (watt-hours).

See Also:

PowerModelConstants.WATT_HOURS

calculateNext

public final org.jscience.physics.amount.Amount<javax.measure.quantity.Energy> calculateNext(javax.measure.Measurable<javax.measure.quantity.Power> newPowerSample)

Calculates the next energy sample, i.e., the next integration step is done.

Parameters:

newPowerSample - A Measurable holding the (most recent) power sample to be used for calculation.

Returns:

An Amount holding the calculated cumulative energy sample.

Throws:

IllegalArgumentException - In case the given power sample is null.