org.flexiblepower.ral.values

Class CommodityMeasurables

java.lang.Object

org.flexiblepower.ral.values.CommodityMap<javax.measure.Measurable<?>>

org.flexiblepower.ral.values.CommodityMeasurables

All Implemented Interfaces:

java.util.Map<Commodity<?,?>,javax.measure.Measurable<?>>

public final class CommodityMeasurables
extends CommodityMap<javax.measure.Measurable<?>>

The CommodityMeasurable is used to store a Measurable for each Commodity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommodityMeasurables.Builder This helper class makes it easy to create an instance of the CommodityMeasurables.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommodityMeasurables(javax.measure.Measurable<javax.measure.quantity.Power> electricityValue, javax.measure.Measurable<javax.measure.quantity.VolumetricFlowRate> gasValue, javax.measure.Measurable<javax.measure.quantity.Power> heatValue)

Method Summary

Methods

Modifier and Type	Method and Description
static CommodityMeasurables.Builder	create()
static CommodityMeasurables	electricity(javax.measure.Measurable<javax.measure.quantity.Power> electricityValue)
static CommodityMeasurables	gas(javax.measure.Measurable<javax.measure.quantity.VolumetricFlowRate> gasValue)
<BQ extends javax.measure.quantity.Quantity,FQ extends javax.measure.quantity.Quantity> javax.measure.Measurable<FQ>	get(Commodity<BQ,FQ> commodity)
static CommodityMeasurables	heat(javax.measure.Measurable<javax.measure.quantity.Power> heatValue)

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

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

CommodityMeasurables

protected CommodityMeasurables(javax.measure.Measurable<javax.measure.quantity.Power> electricityValue,
                    javax.measure.Measurable<javax.measure.quantity.VolumetricFlowRate> gasValue,
                    javax.measure.Measurable<javax.measure.quantity.Power> heatValue)

Method Detail

create

public static CommodityMeasurables.Builder create()

Returns:

A new CommodityMeasurables.Builder object that can be used to create the CommodityMeasurables more easily.

electricity

public static CommodityMeasurables electricity(javax.measure.Measurable<javax.measure.quantity.Power> electricityValue)

Parameters:

electricityValue - The measurable value of the electricity

Returns:

A CommodityMeasurables which only contains a value for Commodity.ELECTRICITY

gas

public static CommodityMeasurables gas(javax.measure.Measurable<javax.measure.quantity.VolumetricFlowRate> gasValue)

Parameters:

gasValue - The measurable value of the gas

Returns:

A CommodityMeasurables which only contains a value for Commodity.GAS

heat

public static CommodityMeasurables heat(javax.measure.Measurable<javax.measure.quantity.Power> heatValue)

Parameters:

heatValue - The measurable value of the heat

Returns:

A CommodityMeasurables which only contains a value for Commodity.HEAT

get

public <BQ extends javax.measure.quantity.Quantity,FQ extends javax.measure.quantity.Quantity> javax.measure.Measurable<FQ> get(Commodity<BQ,FQ> commodity)