org.flexiblepower.api.efi.bufferhelper

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

java.lang.Object

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

Type Parameters:

Q - The quantity type of the buffer

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

The BufferActuator that integrates updated EFI messages and provides additional methods.

Constructor Summary

Constructors

Constructor and Description
BufferActuator(Actuator ac, Buffer<Q> parentBuffer) Constructs a BufferActuator from the Actuator information in a message.

Method Summary

Methods

Modifier and Type	Method and Description
int	getActuatorId() Gets the identifier of this actuator.
java.lang.String	getActuatorLabel() Gets the friendly label for this actuator.
java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>>	getAllRunningModes() Gets all RunningModes of this actuator.
java.util.Map<java.lang.Integer,TimerModel>	getAllTimers() Gets all the timers of all of the transitions of all of the running modes.
int	getCurrentRunningModeId() Gets the identifier of the current running mode.
double	getMaximumFillLevel() Gets the maximum fill level of the buffer actuator expressed in the agreed upon unit.
double	getMinimumFillLevel() Gets the minimum fill level of the buffer actuator expressed in the agreed upon unit.
java.util.List<javax.measure.Measurable<javax.measure.quantity.Power>>	getPossibleDemands(java.util.Date moment, double fillLevel) Gets the electrical demands of all reachable RunningModes at this moment including the current one, given this fill level of the buffer.
java.util.Set<java.lang.Integer>	getReachableRunningModeIds(java.util.Date now) Returns the reachableRunning mode ids including the current one, if it may stay in it.
java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>>	getReachableRunningModes(java.util.Date now) Returns the reachableRunning modes including the current one, if it may stay in it.
CommoditySet	getSupportedCommodities() Returns the commodities that this actuator is able to use as either input or output.
boolean	hasRunningMode(int rmId) Returns whether the RunningMode id is valid for this actuator.
protected void	setAllRunningModes(java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>> runningModes) Renews the set of RunningModes of this Actuator.
void	setCurrentRunningModeId(int currentRunningModeId) Sets the current running mode.
void	updateTimer(int timerId, java.util.Date finishedAt) Upon receiving an update, the end time of the given timer is updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferActuator

public BufferActuator(Actuator ac,
              Buffer<Q> parentBuffer)

Constructs a BufferActuator from the Actuator information in a message. The BufferActuator persists so that any updates to the actuator can be integrated in this single object.

Parameters:

ac - The Actuator's initial information.

parentBuffer - The Parent Buffer (to gain access to the fill level).

Method Detail

getCurrentRunningModeId

public int getCurrentRunningModeId()

Gets the identifier of the current running mode.

Returns:

The identifier of the current running mode.

setCurrentRunningModeId

public void setCurrentRunningModeId(int currentRunningModeId)
                             throws java.lang.IllegalArgumentException

Sets the current running mode.

Parameters:

currentRunningModeId -

Throws:

java.lang.IllegalArgumentException - When running mode id is not valid.

getAllRunningModes

public java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>> getAllRunningModes()

Gets all RunningModes of this actuator.

Returns:

Gets all RunningModes of this actuator.

setAllRunningModes

protected void setAllRunningModes(java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>> runningModes)

Renews the set of RunningModes of this Actuator.

Parameters:

runningModes -

hasRunningMode

public boolean hasRunningMode(int rmId)

Returns whether the RunningMode id is valid for this actuator.

Parameters:

rmId - the Id of the RunningMode.

Returns:

True when the RunningMode exists for this actuator, false otherwise.

getReachableRunningModes

public java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>> getReachableRunningModes(java.util.Date now)
                                                                                                    throws java.lang.IllegalArgumentException

Returns the reachableRunning modes including the current one, if it may stay in it. Returns the empty set if it has not yet received enough information(All EFI messages including BufferStateUpdate message).

Parameters:

now - The current time.

Returns:

The reachable running modes including the current one.

Throws:

java.lang.IllegalArgumentException - When an unknown running mode id is returned from the reachable running modes.

getReachableRunningModeIds

public java.util.Set<java.lang.Integer> getReachableRunningModeIds(java.util.Date now)

Returns the reachableRunning mode ids including the current one, if it may stay in it. Returns the empty set if it has not yet received enough information (All EFI messages including BufferStateUpdate message).

Parameters:

now - The current time.

Returns:

The reachable running mode ids including the current one.

getAllTimers

public java.util.Map<java.lang.Integer,TimerModel> getAllTimers()

Gets all the timers of all of the transitions of all of the running modes.

Returns:

A Map of timer id and timers.

getSupportedCommodities

public CommoditySet getSupportedCommodities()

Returns the commodities that this actuator is able to use as either input or output.

Returns:

The set of commodities and whether they are supported by this actuator.

updateTimer

public void updateTimer(int timerId,
               java.util.Date finishedAt)

Upon receiving an update, the end time of the given timer is updated.

Parameters:

timerId - The id of the timer.

finishedAt - The new finishedAt time that overwrites the old one.

getPossibleDemands

public java.util.List<javax.measure.Measurable<javax.measure.quantity.Power>> getPossibleDemands(java.util.Date moment,
                                                                                        double fillLevel)
                                                                                          throws java.lang.IllegalArgumentException

Gets the electrical demands of all reachable RunningModes at this moment including the current one, given this fill level of the buffer. It returns an empty list when there has not been a state update.

Parameters:

moment - The moment of interest.

fillLevel - The buffer's current fill level expressed as a value where 0 is the minimum and 1 is the maximum. Its unit is the agreed upon unit.

Returns:

An unordered list of the possible electricity consumption demands of the RunningModes, possibly including running modes with the same power demand. For fill levels outside the defined minimum and maximum range, the minimum and maximum value is returned.

Throws:

java.lang.IllegalArgumentException - When a FillLevelFunction of a reachable state has no range elements.

getMinimumFillLevel

public double getMinimumFillLevel()
                           throws java.lang.IllegalStateException

Gets the minimum fill level of the buffer actuator expressed in the agreed upon unit.

Returns:

The minimum fill level of the buffer actuator.

Throws:

java.lang.IllegalStateException - Thrown when no running mode is known yet and a minimum fill level is requested.

getMaximumFillLevel

public double getMaximumFillLevel()
                           throws java.lang.IllegalStateException

Gets the maximum fill level of the buffer actuator expressed in the agreed upon unit.

Returns:

The maximum fill level of the buffer actuator.

Throws:

java.lang.IllegalStateException - Thrown when no running mode is known yet and a maximum fill level is requested.

getActuatorId

public int getActuatorId()

Gets the identifier of this actuator.

Returns:

The identifier of this actuator.

getActuatorLabel

public java.lang.String getActuatorLabel()

Gets the friendly label for this actuator.

Returns:

The string containing the friendly name for this actuator.