net.powermatcher.api.data

Class PointBid

java.lang.Object

net.powermatcher.api.data.Bid

net.powermatcher.api.data.PointBid

All Implemented Interfaces:

java.lang.Iterable<PricePoint>

public class PointBid
extends Bid
implements java.lang.Iterable<PricePoint>

This immutable data object represents a Bid with a PricePoint array to represent the bid curve. This is used by Agents that have to create a Bid, because it is easier to create.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PointBid.Builder A builder class to create an PointBid instance.

Field Summary

Fields inherited from class net.powermatcher.api.data.Bid

marketBasis, SMALLEST_DEMAND

Constructor Summary

Constructors

Constructor and Description
PointBid(MarketBasis marketBasis, PricePoint... pricePoints) A constructor to create an instance of PointBid.

Method Summary

Methods

Modifier and Type	Method and Description
ArrayBid	aggregate(Bid other) Aggregates this Bid instance with another Bid.
Price	calculateIntersection(double targetDemand) Calculates the Price at the intersection with the bid curve at the given demand.
boolean	equals(java.lang.Object obj)
double	getDemandAt(Price price) Calculates the demand at the intersection in the bid curve with the priceStep in a demand array.
double	getMaximumDemand()
double	getMinimumDemand()
PricePoint[]	getPricePoints()
int	hashCode()
java.util.Iterator<PricePoint>	iterator()
ArrayBid	toArrayBid()
PointBid	toPointBid()
java.lang.String	toString()

Methods inherited from class net.powermatcher.api.data.Bid

demandIsEqual, flatDemand, getDemandAt, getMarketBasis

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PointBid

public PointBid(MarketBasis marketBasis,
        PricePoint... pricePoints)

A constructor to create an instance of PointBid.

Parameters:

marketBasis - the MarketBasis of the cluster

pricePoints - the PointBid Array that belongs to this bid.

Method Detail

aggregate

public ArrayBid aggregate(Bid other)

Aggregates this Bid instance with another Bid. Bid are aggregated by adding their bid curves.

Specified by:

aggregate in class Bid

Parameters:

other - The Bid whose bid curve has to be added to the bid curve of this instance.

Returns:

A new aggregated Bid.

calculateIntersection

public Price calculateIntersection(double targetDemand)

Calculates the Price at the intersection with the bid curve at the given demand.

Specified by:

calculateIntersection in class Bid

Parameters:

targetDemand - the part of the bid curve you want to get the Price of.

Returns:

the calculatedPrice

getMaximumDemand

public double getMaximumDemand()

Specified by:

getMaximumDemand in class Bid

Returns:

the highest demand in the demand curve.

getMinimumDemand

public double getMinimumDemand()

Specified by:

getMinimumDemand in class Bid

Returns:

the lowest demand in the demand curve.

toArrayBid

public ArrayBid toArrayBid()

Specified by:

toArrayBid in class Bid

Returns:

The ArrayBid implementation of this Bid.

toPointBid

public PointBid toPointBid()

Specified by:

toPointBid in class Bid

Returns:

The PointBid implementation of this Bid.

getDemandAt

public double getDemandAt(Price price)

Calculates the demand at the intersection in the bid curve with the priceStep in a demand array. Implementation note: you should always override either this method or the Bid.getDemandAt(PriceStep) method. The default implementation is to call the other.

Overrides:

getDemandAt in class Bid

Parameters:

price - the Price you want to know the demand of.

Returns:

the calculated demand

iterator

public java.util.Iterator<PricePoint> iterator()

Specified by:

iterator in interface java.lang.Iterable<PricePoint>

getPricePoints

public PricePoint[] getPricePoints()

Returns:

a copy of pricePoints.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object