org.powertac.common.msg
Class ControlEvent

java.lang.Object
  org.powertac.common.state.XStreamStateLoggable
      org.powertac.common.TariffMessage
          org.powertac.common.msg.TariffUpdate
              org.powertac.common.msg.ControlEvent

All Implemented Interfaces:

ValidatableMessage

Direct Known Subclasses:

BalancingControlEvent, EconomicControlEvent

public abstract class ControlEvent
extends TariffUpdate

Message sent by a broker to the subscribers to a particular tariff, requesting them to curtail usage against that tariff in the specified timeslot. The curtailmentRatio parameter specifies the portion of total usage that will be curtailed for that timeslot, but the actual curtailment is also constrained by the Rate in effect during that timeslot, so it might be less. Customer models can interpret this ratio in two ways: First, it might be that an individual customer reduces usage by that amount over what would have been used otherwise; second, it might be that the specified proportion of the population represented by the customer model is completely curtailed during that timeslot.

Author:

John Collins

Field Summary

Fields inherited from class org.powertac.common.TariffMessage

broker, id

Constructor Summary

protected

ControlEvent()

Method Summary

int	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

ControlEvent

protected ControlEvent()

Method Detail

getTimeslotIndex

public int getTimeslotIndex()