Package agents.markets.meritOrder.books

Class SupplyOrderBook

java.lang.Object

agents.markets.meritOrder.books.OrderBook

agents.markets.meritOrder.books.SupplyOrderBook

All Implemented Interfaces:

de.dlr.gitlab.fame.communication.transfer.Portable, Cloneable

public class SupplyOrderBook
extends OrderBook
implements Cloneable

OrderBook that manages all OrderBookItems from supply-Bids

Author:

Martin Klein, Christoph Schimeczek

Nested Class Summary

Nested classes/interfaces inherited from class agents.markets.meritOrder.books.OrderBook

OrderBook.DistributionMethod

Field Summary

Fields inherited from class agents.markets.meritOrder.books.OrderBook

awardedCumulativePower, awardedPrice, isSorted, orderBookItems

Constructor Summary

Constructors

Constructor	Description
SupplyOrderBook()

Method Summary

Modifier and Type	Method	Description
SupplyOrderBook	clone()
OrderBookItem	getHighestItem()
OrderBookItem	getLastAwardedItem()	Can only be called once the book is updated after market clearing
protected Bid	getLastBid()
protected Comparator<OrderBookItem>	getSortComparator()

Methods inherited from class agents.markets.meritOrder.books.OrderBook

addBid, addBids, addComponentsTo, clear, ensureNotYetSortedOrThrow, ensurePositiveBidPower, ensureSortedOrThrow, filterForBidsByTrader, getCumulatePowerOfItems, getOrderBookItems, getTradersSumOfPower, hasNoValidBids, populate, toString, updateAwardedPowerInBids

Methods inherited from class java.lang.Object

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

Constructor Detail

SupplyOrderBook

public SupplyOrderBook()

Method Detail

getLastBid

protected Bid getLastBid()

Specified by:

getLastBid in class OrderBook

Returns:

the last virtual Bid depending on the type of order book

getSortComparator

protected Comparator<OrderBookItem> getSortComparator()

Specified by:

getSortComparator in class OrderBook

Returns:

Comparator to sort OrderBook.orderBookItems with

getHighestItem

public OrderBookItem getHighestItem()

Returns:

most expensive (real) bid (i.e. with block power is larger than 0); may only be called after sorting

getLastAwardedItem

public OrderBookItem getLastAwardedItem()

Can only be called once the book is updated after market clearing

Returns:

one of possibly many OrderBookItems that were price setting
may only be called after sorting and awarding

clone

public SupplyOrderBook clone()

Overrides:

clone in class Object

Returns:

a deep copy of SupplyOrderBook caller