org.flexiblepower.ral.values

Class Commodity.Electricity

java.lang.Object

org.flexiblepower.ral.values.Commodity<javax.measure.quantity.Energy,javax.measure.quantity.Power>

org.flexiblepower.ral.values.Commodity.Electricity

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Commodity<BQ extends javax.measure.quantity.Quantity,FQ extends javax.measure.quantity.Quantity>

public static final class Commodity.Electricity
extends Commodity<javax.measure.quantity.Energy,javax.measure.quantity.Power>

The Commodity.Electricity commodity. The billable unit is in kWh. The flow unit is in watt. This is a singleton object (see Commodity.ELECTRICITY);

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.flexiblepower.ral.values.Commodity

Commodity.Electricity, Commodity.Gas, Commodity.Heat

Field Summary

Fields inherited from class org.flexiblepower.ral.values.Commodity

ELECTRICITY, GAS, HEAT

Method Summary

Methods

Modifier and Type	Method and Description
javax.measure.Measurable<javax.measure.quantity.Energy>	amount(javax.measure.Measurable<javax.measure.quantity.Power> average, javax.measure.Measurable<javax.measure.quantity.Duration> duration)
javax.measure.Measurable<javax.measure.quantity.Power>	average(javax.measure.Measurable<javax.measure.quantity.Energy> amount, javax.measure.Measurable<javax.measure.quantity.Duration> duration)

Methods inherited from class org.flexiblepower.ral.values.Commodity

getBillableUnit, getFlowUnit, toString

Methods inherited from class java.lang.Object

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

Method Detail

average

public javax.measure.Measurable<javax.measure.quantity.Power> average(javax.measure.Measurable<javax.measure.quantity.Energy> amount,
                                                             javax.measure.Measurable<javax.measure.quantity.Duration> duration)

Specified by:

average in class Commodity<javax.measure.quantity.Energy,javax.measure.quantity.Power>

Parameters:

amount - The billable amount of this commodity

duration - The duration over which the amount has been measured

Returns:

The flow amount that represents the average flow, using the total amount sent over the given duration.

amount

public javax.measure.Measurable<javax.measure.quantity.Energy> amount(javax.measure.Measurable<javax.measure.quantity.Power> average,
                                                             javax.measure.Measurable<javax.measure.quantity.Duration> duration)

Specified by:

amount in class Commodity<javax.measure.quantity.Energy,javax.measure.quantity.Power>

Parameters:

average - The average flow amount of this commodity

duration - The duration over which the flow has been measured

Returns:

The billable amount that represents the total amount that has been measured