Package org.powertac.common.msg

Class BalancingControlEvent

java.lang.Object

org.powertac.common.state.XStreamStateLoggable

org.powertac.common.TariffMessage

org.powertac.common.msg.TariffUpdate

org.powertac.common.msg.ControlEvent

org.powertac.common.msg.BalancingControlEvent

All Implemented Interfaces:

ValidatableMessage

@Domain(fields={"tariffId","kwh","payment","timeslotIndex"})
public class BalancingControlEvent
extends ControlEvent

Represents up-regulation or down-regulation by the DU as part of its balancing process. A BalancingControlEvent can only be used by the DU in response to a BalancingOrder issued by a Broker, and only if needed to resolve an imbalance.

Author:

John Collins

Field Summary

Fields inherited from class org.powertac.common.TariffMessage

broker, id

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BalancingControlEvent()
	BalancingControlEvent(TariffSpecification spec, double kwh, double payment, int timeslotIndex)	Creates a new BalancingControlEvent to represent regulation in the current timeslot.

Method Summary

Modifier and Type	Method	Description
double	getKwh()
double	getPayment()

Methods inherited from class org.powertac.common.msg.ControlEvent

getTimeslotIndex

Methods inherited from class org.powertac.common.msg.TariffUpdate

getTariffId

Methods inherited from class org.powertac.common.TariffMessage

getBroker, getId, isValid

Methods inherited from class org.powertac.common.state.XStreamStateLoggable

readResolve

Methods inherited from class java.lang.Object

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

Constructor Detail

BalancingControlEvent

public BalancingControlEvent(TariffSpecification spec,
                             double kwh,
                             double payment,
                             int timeslotIndex)

Creates a new BalancingControlEvent to represent regulation in the current timeslot. Presumably this will be generated AFTER the customer models have run in the timeslot, so the customer models must adapt their behavior in the following timeslot to accommodate a curtailment that has already happened. A positive value for kwh indicates curtailment of consumption, which is equivalent to additional energy to the broker's account. However, this value must not be used to keep accounts, because every BalancingControlEvent should be accompanied by a TariffTransaction specifying the same amount of energy.

BalancingControlEvent

protected BalancingControlEvent()

Method Detail

getKwh

public double getKwh()

getPayment

public double getPayment()