org.powertac.common

Class DistributionTransaction

java.lang.Object

org.powertac.common.state.XStreamStateLoggable

org.powertac.common.BrokerTransaction

org.powertac.common.DistributionTransaction

@Domain(fields={"postedTimeslot","NSmall","NLarge","KWh","charge"})
public class DistributionTransaction
extends BrokerTransaction

Represents the fee assessed by the Distribution Utility for transport of energy over its facilities during the current timeslot. The kWh is the total energy delivered, which is the sum of the positive net load of the broker's customers, and the positive net export of energy through the wholesale market. Negative values are ignored.

Author:

John Collins

Field Summary

Fields inherited from class org.powertac.common.BrokerTransaction

broker, id, postedTimeslot

Constructor Summary

Constructors

Constructor and Description
DistributionTransaction(Broker broker, int when, double kwh, double charge)
DistributionTransaction(Broker broker, int when, int nSmall, int nLarge, double kwh, double charge)

Method Summary

Modifier and Type	Method and Description
double	getCharge() Returns the total fee assessed for transport and customer connections.
double	getKWh() Returns the transported energy quantity represented by this transaction.
int	getNLarge() Returns the number of large customer subscriptions for which meter fees are assessed.
int	getNSmall() Returns the number of small customer subscriptions for which meter fees are assessed.
double	getQuantity() Deprecated.
String	toString()

Methods inherited from class org.powertac.common.BrokerTransaction

getBroker, getId, getPostedTime, getPostedTimeslot, getPostedTimeslotIndex

Methods inherited from class org.powertac.common.state.XStreamStateLoggable

readResolve

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionTransaction

@ChainedConstructor
public DistributionTransaction(Broker broker,
                                                   int when,
                                                   double kwh,
                                                   double charge)

DistributionTransaction

public DistributionTransaction(Broker broker,
                               int when,
                               int nSmall,
                               int nLarge,
                               double kwh,
                               double charge)

Method Detail

getQuantity

@Deprecated
public double getQuantity()

Deprecated.

getKWh

public double getKWh()

Returns the transported energy quantity represented by this transaction. Will be non-zero only if transport fees are being assessed.

getNSmall

public int getNSmall()

Returns the number of small customer subscriptions for which meter fees are assessed.

getNLarge

public int getNLarge()

Returns the number of large customer subscriptions for which meter fees are assessed.

getCharge

public double getCharge()

Returns the total fee assessed for transport and customer connections.

toString

public String toString()

Overrides:

toString in class Object