org.powertac.common.msg
Class EconomicControlEvent

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.EconomicControlEvent

public class EconomicControlEvent
extends ControlEvent

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

EconomicControlEvent(TariffSpecification tariff, double curtailmentRatio, int timeslotIndex)
Creates a new EconomicControlEvent to take effect in the following timeslot.

Method Summary

double

getCurtailmentRatio()

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

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

EconomicControlEvent

public EconomicControlEvent(TariffSpecification tariff,
                            double curtailmentRatio,
                            int timeslotIndex)

Creates a new EconomicControlEvent to take effect in the following timeslot. Package visibility reflects the fact that this is intended to be called by the factory method in ControlEvent.

Method Detail

getCurtailmentRatio

public double getCurtailmentRatio()