org.powertac.common

Class RegulationCapacity

java.lang.Object

org.powertac.common.RegulationCapacity

@Domain
public class RegulationCapacity
extends Object

Accumulates available regulation capacity for a given TariffSubscription. This is basically a data structure that holds two numbers: an amount of up-regulation capacity (non-negative), and an amount of down-regulation capacity (non-positive). The subscription is also included to simplify log analysis; in cases where no subscription is involved, this value should be null.

Author:

John Collins

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
RegulationCapacity(TariffSubscription subscription, double upRegulationCapacity, double downRegulationCapacity) Creates a new RegulationAccumulator instance specifying the amounts of regulating capacity available for up-regulation and down-regulation.

Method Summary

Modifier and Type	Method and Description
double	getDownRegulationCapacity() Returns the available down-regulation capacity in kWh.
long	getId()
double	getUpRegulationCapacity() Returns the available up-regulation capacity in kWh.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.logging.log4j.Logger log

Constructor Detail

RegulationCapacity

public RegulationCapacity(TariffSubscription subscription,
                          double upRegulationCapacity,
                          double downRegulationCapacity)

Creates a new RegulationAccumulator instance specifying the amounts of regulating capacity available for up-regulation and down-regulation. Values are expressed with respect to the balancing market; a negative value means power is delivered to the customer (down-regulation), and a positive value means power is delivered to the balancing market (up-regulation).

Method Detail

getId

public long getId()

getUpRegulationCapacity

public double getUpRegulationCapacity()

Returns the available up-regulation capacity in kWh. Value is non-negative.

getDownRegulationCapacity

public double getDownRegulationCapacity()

Returns the available down-regulation capacity in kWh. Value is non-positive.