org.flexiblepower.api.efi.bufferhelper

Class Buffer<Q extends javax.measure.quantity.Quantity>

java.lang.Object

org.flexiblepower.api.efi.bufferhelper.Buffer<Q>

Type Parameters:

Q - The quantity that describes what is stored in the buffer (e.g. temperature or electricity).

public class Buffer<Q extends javax.measure.quantity.Quantity>
extends java.lang.Object

This class processes EFI messages: (buffer registration, system description and update messages). It offers helper methods for the agent to make bids.

Constructor Summary

Constructors

Constructor and Description
Buffer(BufferRegistration<Q> br) A Buffer may only be constructed from a complete BufferRegistration message.

Method Summary

Methods

Modifier and Type	Method and Description
BufferActuator<Q>	getActuatorById(int id) Returns the Actuator object based on the id.
java.util.Map<java.lang.Integer,BufferActuator<Q>>	getActuators() Gets all actuators indexed on their id.
javax.measure.Measurable<javax.measure.quantity.Duration>	getAllocationDelay() Gets the allocation delay.
double	getCurrentFillFraction() Gets the fill level of the buffer relative to the maximum and minimum fill level.
javax.measure.Measurable<Q>	getCurrentFillLevel() Gets the current fill level of the buffer.
java.util.Map<java.lang.Integer,BufferActuator<Q>>	getElectricalActuatorMap() Checks all the actuators for those of type electricity and returns them in an ArrayList.
java.util.List<BufferActuator<Q>>	getElectricalActuators() Checks all the actuators for those of type electricity and returns them in an ArrayList.
java.lang.String	getFillLevelLabel() Gets the label of the fill level.
FillLevelFunction<LeakageRate>	getLeakageFunction() Returns the buffer leakage function.
double	getMaximumFillLevel()
double	getMinimumFillLevel() For a heat pump, minimum fill level is the lowest temperature of the buffer.
java.lang.String	getResourceId() Gets the identifier of the resource.
javax.measure.unit.Unit<Q>	getUnit() Gets the default fill level unit of this buffer.
boolean	hasReceivedStateUpdate() Returns whether a state update has been received.
boolean	hasReceivedSystemDescription() Returns whether this Buffer has received a system description or not yet.
void	processStateUpdate(BufferStateUpdate<Q> bsu) BufferStateUpdate information is added to the internal model.
void	processSystemDescription(BufferSystemDescription bsd) BufferSystemDescription message's information is copied to the internal model of the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Buffer

public Buffer(BufferRegistration<Q> br)

A Buffer may only be constructed from a complete BufferRegistration message.

Parameters:

br - A complete buffer registration message. (This is enforced in the message constructor).

Method Detail

processSystemDescription

public void processSystemDescription(BufferSystemDescription bsd)

BufferSystemDescription message's information is copied to the internal model of the buffer.

Parameters:

bsd - The buffer system description message.

Throws:

java.lang.IllegalArgumentException - When the ActuatorId in the BufferSystemDescription is not known

processStateUpdate

public void processStateUpdate(BufferStateUpdate<Q> bsu)

BufferStateUpdate information is added to the internal model.

Parameters:

bsu - The BufferStateUpdate message.

Throws:

java.lang.IllegalArgumentException - Throws when the ActuatorId, RunningModeId or timerId is not known.

getElectricalActuators

public java.util.List<BufferActuator<Q>> getElectricalActuators()

Checks all the actuators for those of type electricity and returns them in an ArrayList.

Returns:

A list of all electrical BufferActuators or an empty list if none are found.

getElectricalActuatorMap

public java.util.Map<java.lang.Integer,BufferActuator<Q>> getElectricalActuatorMap()

Checks all the actuators for those of type electricity and returns them in an ArrayList.

Returns:

A Map of all electrical BufferActuators or an empty list if none are found. The key is the Actuator Id.

getCurrentFillFraction

public double getCurrentFillFraction()
                              throws java.lang.IllegalStateException,
                                     java.lang.IllegalArgumentException

Gets the fill level of the buffer relative to the maximum and minimum fill level. It is expressed in the fill level unit that is defined in the registration message.

Returns:

The fill fraction computed where 0 is minimum and 1 is the maximum fill level. May be bigger than 1 or smaller than 0 (when circumstances cause the buffer temperature to go out of the bounds of the minimum and maximum).

Throws:

java.lang.IllegalArgumentException - When minimum fill level is greater than or equal to the maximum fill level, this throws.

java.lang.IllegalStateException - When no information is available yet about the state of the buffer.

getCurrentFillLevel

public javax.measure.Measurable<Q> getCurrentFillLevel()
                                                                                        throws java.lang.IllegalStateException

Gets the current fill level of the buffer. May be outside of the 'official' range of the running modes.

Returns:

A Measurable object containing the current fill level of the buffer and quantity information.

Throws:

java.lang.IllegalStateException - When no state update has been received.

hasReceivedSystemDescription

public boolean hasReceivedSystemDescription()

Returns whether this Buffer has received a system description or not yet.

Returns:

Whether this buffer has received a system description yet.

hasReceivedStateUpdate

public boolean hasReceivedStateUpdate()

Returns whether a state update has been received.

Returns:

Whether it has received state update.

getMinimumFillLevel

public double getMinimumFillLevel()
                           throws java.lang.IllegalStateException

For a heat pump, minimum fill level is the lowest temperature of the buffer. For a freezer, minimum fill level is the lowest temperature of the freezer.

Returns:

The minimum of all actuators, not only the electrical.

Throws:

java.lang.IllegalStateException - When no system description has been received, this throws.

getMaximumFillLevel

public double getMaximumFillLevel()
                           throws java.lang.IllegalStateException

Returns:

The maximum of all actuators, not only the electrical.

Throws:

java.lang.IllegalStateException

getAllocationDelay

public javax.measure.Measurable<javax.measure.quantity.Duration> getAllocationDelay()

Gets the allocation delay.

Returns:

A Measurable that represents the allocation delay as a duration.

getLeakageFunction

public FillLevelFunction<LeakageRate> getLeakageFunction()

Returns the buffer leakage function.

Returns:

The leakage function of the buffer.

getResourceId

public java.lang.String getResourceId()

Gets the identifier of the resource.

Returns:

getFillLevelLabel

public java.lang.String getFillLevelLabel()

Gets the label of the fill level.

Returns:

The label of the fill level.

getUnit

public javax.measure.unit.Unit<Q> getUnit()

Gets the default fill level unit of this buffer.

Returns:

The default unit in which the fill level is expressed.

getActuators

public java.util.Map<java.lang.Integer,BufferActuator<Q>> getActuators()

Gets all actuators indexed on their id.

Returns:

A map with all actuators indexed on their id.

getActuatorById

public BufferActuator<Q> getActuatorById(int id)

Returns the Actuator object based on the id.

Parameters:

id - The id of the actuator.

Returns:

The actuator object.