org.flexiblepower.ral.values

Class CommodityUncertainMeasurables

java.lang.Object

org.flexiblepower.ral.values.CommodityMap<UncertainMeasure<?>>

org.flexiblepower.ral.values.CommodityUncertainMeasurables

All Implemented Interfaces:

java.util.Map<Commodity<?,?>,UncertainMeasure<?>>

public final class CommodityUncertainMeasurables
extends CommodityMap<UncertainMeasure<?>>

The CommodityUncertainMeasurables is used to store a UncertainMeasure for each Commodity.

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
static CommodityUncertainMeasurables.Builder	create()
static CommodityUncertainMeasurables	electricity(UncertainMeasure<javax.measure.quantity.Power> electricityValue)
static CommodityUncertainMeasurables	gas(UncertainMeasure<javax.measure.quantity.VolumetricFlowRate> gasValue)
<BQ extends javax.measure.quantity.Quantity,FQ extends javax.measure.quantity.Quantity> UncertainMeasure<FQ>	get(Commodity<BQ,FQ> commodity)
static CommodityUncertainMeasurables	heat(UncertainMeasure<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

Method Detail

create

public static CommodityUncertainMeasurables.Builder create()

Returns:

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

electricity

public static CommodityUncertainMeasurables electricity(UncertainMeasure<javax.measure.quantity.Power> electricityValue)

Parameters:

electricityValue - The measurable value of the electricity

Returns:

A CommodityUncertainMeasurables which only contains a value for Commodity.ELECTRICITY

gas

public static CommodityUncertainMeasurables gas(UncertainMeasure<javax.measure.quantity.VolumetricFlowRate> gasValue)

Parameters:

gasValue - The measurable value of the gas

Returns:

A CommodityUncertainMeasurables which only contains a value for Commodity.GAS

heat

public static CommodityUncertainMeasurables heat(UncertainMeasure<javax.measure.quantity.Power> heatValue)

Parameters:

heatValue - The measurable value of the heat

Returns:

A CommodityUncertainMeasurables which only contains a value for Commodity.HEAT

get

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