org.flexiblepower.efi.buffer

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

java.lang.Object

org.flexiblepower.ral.messages.ResourceMessage

org.flexiblepower.ral.messages.ControlSpaceUpdate

org.flexiblepower.efi.buffer.BufferUpdate

org.flexiblepower.efi.buffer.BufferStateUpdate<Q>

Type Parameters:

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

public class BufferStateUpdate<Q extends javax.measure.quantity.Quantity>
extends BufferUpdate

This class contains up to date information about the state of the buffer.

Constructor Summary

Constructors

Constructor and Description
BufferStateUpdate(BufferRegistration<Q> bufferRegistration, java.util.Date timestamp, java.util.Date validFrom, javax.measure.Measurable<Q> currentFillLevel, java.util.Set<ActuatorUpdate> currentRunningMode) Constructs a new BufferStateUpdate message with the specific validFrom

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
javax.measure.Measurable<Q>	getCurrentFillLevel()
double	getCurrentFillLevelAsDouble(javax.measure.unit.Unit<Q> unit)
java.util.Set<ActuatorUpdate>	getCurrentRunningMode()
int	hashCode()
protected void	toString(java.lang.StringBuilder sb)

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

getValidFrom

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

BufferStateUpdate

public BufferStateUpdate(BufferRegistration<Q> bufferRegistration,
                 java.util.Date timestamp,
                 java.util.Date validFrom,
                 javax.measure.Measurable<Q> currentFillLevel,
                 java.util.Set<ActuatorUpdate> currentRunningMode)

Constructs a new BufferStateUpdate message with the specific validFrom

Parameters:

bufferRegistration - The registration message to which this update is referring to

timestamp - The moment when this constructor is called

validFrom - This timestamp indicates from which moment on this update is valid.

currentFillLevel - This value represents the current fill level of the buffer.

currentRunningMode - This is a set of zero or more current running modes. For every actuator there will be one current running mode.

Method Detail

getCurrentFillLevel

public javax.measure.Measurable<Q> getCurrentFillLevel()

Returns:

This value represents the current fill level of the buffer.

getCurrentFillLevelAsDouble

public double getCurrentFillLevelAsDouble(javax.measure.unit.Unit<Q> unit)

Parameters:

unit - The unit in which we want the current fill level to be expressed

Returns:

This value represents the current fill level of the buffer

getCurrentRunningMode

public java.util.Set<ActuatorUpdate> getCurrentRunningMode()

Returns:

This is a set of zero or more current running modes. For every actuator there will be one current running mode.

hashCode

public int hashCode()

Overrides:

hashCode in class ControlSpaceUpdate

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ControlSpaceUpdate

toString

protected void toString(java.lang.StringBuilder sb)

Overrides:

toString in class ControlSpaceUpdate