org.flexiblepower.efi.uncontrolled

Class UncontrolledRegistration

java.lang.Object

org.flexiblepower.ral.messages.ResourceMessage

org.flexiblepower.ral.messages.ControlSpaceRegistration

org.flexiblepower.efi.uncontrolled.UncontrolledRegistration

public final class UncontrolledRegistration
extends ControlSpaceRegistration

The UncontrolledRegistration object registers the uncontrolled resource manager to the energy app, the message is describes the commodities that are consumed or produced by the uncontrolled appliance with the Commodity attribute. Furthermore if the modelled appliance has features that allow curtailing the consumption or production of the device, the curtail options can be expressed in a ConstraintList for every commodity.

Constructor Summary

Constructors

Constructor and Description
UncontrolledRegistration(java.lang.String resourceId, java.util.Date timestamp, javax.measure.Measurable<javax.measure.quantity.Duration> allocationDelay, CommoditySet supportedCommodities, ConstraintListMap supportedCommodityCurtailments)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
<FQ extends javax.measure.quantity.Quantity> ConstraintList<FQ>	getCurtailment(Commodity<?,FQ> commodity)
CommoditySet	getSupportedCommodities()
int	hashCode()
boolean	supportsCommodity(Commodity<?,?> commodity)
protected void	toString(java.lang.StringBuilder sb)

Methods inherited from class org.flexiblepower.ral.messages.ControlSpaceRegistration

getAllocationDelay

Methods inherited from class org.flexiblepower.ral.messages.ResourceMessage

getResourceId, getResourceMessageId, getTimestamp, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UncontrolledRegistration

public UncontrolledRegistration(java.lang.String resourceId,
                        java.util.Date timestamp,
                        javax.measure.Measurable<javax.measure.quantity.Duration> allocationDelay,
                        CommoditySet supportedCommodities,
                        ConstraintListMap supportedCommodityCurtailments)

Parameters:

resourceId - The resource identifier

timestamp - The moment when this constructor is called)

allocationDelay - The duration of the delay in communications channel from the moment of sending to the moment the command is executed up by the device.

supportedCommodityCurtailments - A map of every applicable Commodity for the appliance as key and a ConstriantList representing the list of possible curtail steps as an value. The value of the map is optional and will only be provided if the appliance support curtailing, otherwise it must be null.

Method Detail

getCurtailment

public <FQ extends javax.measure.quantity.Quantity> ConstraintList<FQ> getCurtailment(Commodity<?,FQ> commodity)

Parameters:

commodity - The commodity for which the ConstraintList will be returned

Returns:

The curtailment for the specific commodity or null if not available

getSupportedCommodities

public CommoditySet getSupportedCommodities()

Returns:

The commodities that are supported by the device

supportsCommodity

public boolean supportsCommodity(Commodity<?,?> commodity)

Returns:

true if the given commodity is supported

hashCode

public int hashCode()

Overrides:

hashCode in class ControlSpaceRegistration

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ControlSpaceRegistration

toString

protected void toString(java.lang.StringBuilder sb)

Overrides:

toString in class ControlSpaceRegistration