Package org.powertac.factoredcustomer

Class CapacityAccumulator

java.lang.Object

org.powertac.factoredcustomer.CapacityAccumulator

public class CapacityAccumulator
extends Object

Communicates and accumulates capacity information, including production, consumption, up-regulation, and down-regulation. Intended to be used by CapacityOriginator instances to return values to UtilityOptimizers.

Author:

John Collins

Constructor Summary

Constructors

Constructor	Description
CapacityAccumulator()	Creates an empty one
CapacityAccumulator(double capacity, double upRegCap, double downRegCap)	Creates an instance with specific values

Method Summary

Modifier and Type	Method	Description
CapacityAccumulator	add(CapacityAccumulator other)	Adds another CapacityAccumulator to this one.
double	getCapacity()
double	getDownRegulationCapacity()
double	getUpRegulationCapacity()
void	scale(double ratio)	Scales values by ratio.

Methods inherited from class java.lang.Object

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

Constructor Detail

CapacityAccumulator

public CapacityAccumulator()

Creates an empty one

CapacityAccumulator

public CapacityAccumulator(double capacity,
                           double upRegCap,
                           double downRegCap)

Creates an instance with specific values

Method Detail

add

public CapacityAccumulator add(CapacityAccumulator other)

Adds another CapacityAccumulator to this one.

scale

public void scale(double ratio)

Scales values by ratio. Used to adjust for subscription ratios.

getCapacity

public double getCapacity()

getUpRegulationCapacity

public double getUpRegulationCapacity()

getDownRegulationCapacity

public double getDownRegulationCapacity()