org.powertac.common

Class RegulationCapacity

java.lang.Object

org.powertac.common.RegulationCapacity

public class RegulationCapacity
extends Object

Represents 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.log4j.Logger	log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	add(RegulationCapacity rc) Adds the capacities in the given RegulationCapacity instance to this instance.
void	addDownRegulation(double amount) Adds the given amount of down-regulation capacity.
void	addUpRegulation(double amount) Adds the given amount of up-regulation capacity.
double	getDownRegulationCapacity() Returns the available down-regulation capacity in kWh.
long	getId()
double	getUpRegulationCapacity() Returns the available up-regulation capacity in kWh.
void	setDownRegulationCapacity(double value) Sets the down-regulation value.
void	setUpRegulationCapacity(double value) Sets the up-regulation value.

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.log4j.Logger log

Constructor Detail

RegulationCapacity

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

Creates a new RegulationCapacity 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.

setUpRegulationCapacity

public void setUpRegulationCapacity(double value)

Sets the up-regulation value. Argument must be non-negative.

getDownRegulationCapacity

public double getDownRegulationCapacity()

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

setDownRegulationCapacity

public void setDownRegulationCapacity(double value)

Sets the down-regulation value. Argument must be non-negative.

add

public void add(RegulationCapacity rc)

Adds the capacities in the given RegulationCapacity instance to this instance.

addUpRegulation

public void addUpRegulation(double amount)

Adds the given amount of up-regulation capacity. Amount must be non-negative.

addDownRegulation

public void addDownRegulation(double amount)

Adds the given amount of down-regulation capacity. Amount must be non-positive.