Package agents.markets.meritOrder

Class Bid

java.lang.Object

agents.markets.meritOrder.Bid

All Implemented Interfaces:

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

public class Bid
extends Object
implements de.dlr.gitlab.fame.communication.transfer.Portable, Cloneable

A bid offering or requesting a given amount of energy for a specified price

Author:

Martin Klein, Christoph Schimeczek, A. Achraf El Ghazi

Constructor Summary

Constructors

Constructor	Description
Bid()	required for Portables
Bid(double energyAmountInMWH, double offerPriceInEURperMWH)	Creates a Bid with marginalCost=NaN
Bid(double energyAmountInMWH, double offerPriceInEURperMWH, double marginalCostInEURperMWH)	Creates a Bid

Method Summary

Modifier and Type	Method	Description
void	addComponentsTo(de.dlr.gitlab.fame.communication.transfer.ComponentCollector collector)	required for Portables
Bid	clone()
double	getEnergyAmountInMWH()
double	getMarginalCost()
double	getOfferPriceInEURperMWH()
boolean	matches(Bid bid)
void	populate(de.dlr.gitlab.fame.communication.transfer.ComponentProvider provider)	required for Portables
void	setEnergyAmountInMWH(double energyAmountInMWH)	set amount of energy requested or offered (depending on Type of this Bid)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Bid

public Bid()

required for Portables

Bid

public Bid(double energyAmountInMWH,
           double offerPriceInEURperMWH,
           double marginalCostInEURperMWH)

Creates a Bid

Parameters:

energyAmountInMWH - amount of energy requested or offered (depending on Type of this Bid)

offerPriceInEURperMWH - maximum / minimum offer price (depending on Type of this Bid)

marginalCostInEURperMWH - actual marginal cost associated with this Bid

Bid

public Bid(double energyAmountInMWH,
           double offerPriceInEURperMWH)

Creates a Bid with marginalCost=NaN

Parameters:

energyAmountInMWH - amount of energy requested or offered (depending on Type of this Bid)

offerPriceInEURperMWH - maximum / minimum offer price (depending on Type of this Bid)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getOfferPriceInEURperMWH

public double getOfferPriceInEURperMWH()

Returns:

maximum / minimum offer price (depending on Type of this Bid)

getEnergyAmountInMWH

public double getEnergyAmountInMWH()

Returns:

amount of energy requested or offered (depending on Type of this Bid)

setEnergyAmountInMWH

public void setEnergyAmountInMWH(double energyAmountInMWH)

set amount of energy requested or offered (depending on Type of this Bid)

Parameters:

energyAmountInMWH - energy amount to set (in MHW).

getMarginalCost

public double getMarginalCost()

Returns:

actual marginal cost associated with this Bid

addComponentsTo

public void addComponentsTo(de.dlr.gitlab.fame.communication.transfer.ComponentCollector collector)

required for Portables

Specified by:

addComponentsTo in interface de.dlr.gitlab.fame.communication.transfer.Portable

populate

public void populate(de.dlr.gitlab.fame.communication.transfer.ComponentProvider provider)

required for Portables

Specified by:

populate in interface de.dlr.gitlab.fame.communication.transfer.Portable

clone

public Bid clone()

Overrides:

clone in class Object

Returns:

a deep-copy of Bid

matches

public boolean matches(Bid bid)

Parameters:

bid - to check for match.

Returns:

true if this object's content matches that of the given Bid.