org.flexiblepower.ral.messages

Class Allocation

java.lang.Object

org.flexiblepower.ral.messages.ResourceMessage

org.flexiblepower.ral.messages.Allocation

Direct Known Subclasses:

BufferAllocation, TimeShifterAllocation, UnconstrainedAllocation, UncontrolledAllocation

public abstract class Allocation
extends ResourceMessage

An Allocation message is always a response from the energy application to a ControlSpaceUpdate message. It contains instructions on how to use (or fix) the flexibility described in the ControlSpaceUpdate. Each ControlSpace category has its own Allocation message that is derived from this one.

Constructor Summary

Constructors

Constructor and Description
Allocation(java.util.Date timestamp, ControlSpaceUpdate controlSpaceUpdate) Constructs a new Allocation object as a response to a specific ControlSpaceUpdate which is no emergency.
Allocation(java.util.Date timestamp, ControlSpaceUpdate controlSpaceUpdate, boolean isEmergencyAllocation) Constructs a new Allocation object as a response to a specific ControlSpaceUpdate.
Allocation(java.lang.String resourceId, java.util.Date timestamp, java.util.UUID controlSpaceUpdateId, boolean isEmergencyAllocation) Constructs a new Allocation object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.UUID	getControlSpaceUpdateId()
int	hashCode()
boolean	isEmergencyAllocation()
protected void	toString(java.lang.StringBuilder sb)

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

Allocation

public Allocation(java.util.Date timestamp,
          ControlSpaceUpdate controlSpaceUpdate)

Constructs a new Allocation object as a response to a specific ControlSpaceUpdate which is no emergency. This object will return false for the isEmergencyAllocation() method.

Parameters:

timestamp - The moment when this constructor is called

controlSpaceUpdate - The ControlSpaceUpdate object to which this Allocation is responding to.

Allocation

public Allocation(java.util.Date timestamp,
          ControlSpaceUpdate controlSpaceUpdate,
          boolean isEmergencyAllocation)

Constructs a new Allocation object as a response to a specific ControlSpaceUpdate.

Parameters:

timestamp - The moment when this constructor is called

controlSpaceUpdate - The ControlSpaceUpdate object to which this Allocation is responding to.

isEmergencyAllocation - This Boolean value is optional and is true when a grid emergency situation occurs. (e.g. congestion, black start etc.) The energy app then strongly advices the appliance driver to adapt to the sent allocation in order to maintain grid stability.

Allocation

public Allocation(java.lang.String resourceId,
          java.util.Date timestamp,
          java.util.UUID controlSpaceUpdateId,
          boolean isEmergencyAllocation)

Constructs a new Allocation object.

Parameters:

resourceId - The resource identifier

timestamp - The moment when this constructor is called

controlSpaceUpdateId - An identifier that uniquely identifies the ControlSpaceUpdate message that this message is a response to.

isEmergencyAllocation - This Boolean value is optional and is true when a grid emergency situation occurs. (e.g. congestion, black start etc.) The energy app then strongly advices the appliance driver to adapt to the sent allocation in order to maintain grid stability.

Method Detail

getControlSpaceUpdateId

public java.util.UUID getControlSpaceUpdateId()

Returns:

The id of the control space update on which this allocation message is based.

isEmergencyAllocation

public boolean isEmergencyAllocation()

Returns:

This boolean value is optional and is true when a grid emergency situation occurs. (e.g. congestion, black start etc.) The energy application then strongly advices the appliance driver to adapt to the sent allocation in order to maintain grid stability.

hashCode

public int hashCode()

Overrides:

hashCode in class ResourceMessage

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ResourceMessage

toString

protected void toString(java.lang.StringBuilder sb)

Overrides:

toString in class ResourceMessage