Package agents.forecast

Class MarketForecaster

java.lang.Object

de.dlr.gitlab.fame.agent.Agent

agents.forecast.Forecaster

agents.forecast.MarketForecaster

All Implemented Interfaces:

de.dlr.gitlab.fame.agent.AgentAbility

Direct Known Subclasses:

MeritOrderForecaster, PriceForecaster

public abstract class MarketForecaster
extends Forecaster

Common base class related to DayAheadMarket forecasting; issues MarketForecaster.Products.ForecastRequests to ask for required forecasts; uses forecasted bids to clear market ahead of time and thus provide forecasts

Author:

Christoph Schimeczek

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarketForecaster.Products	Products of MarketForecasters

Nested classes/interfaces inherited from class de.dlr.gitlab.fame.agent.Agent

de.dlr.gitlab.fame.agent.Agent.WarmUpStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected TreeMap<de.dlr.gitlab.fame.time.TimeStamp,MarketClearingResult>	calculatedForecastContainer	contains all previously calculated forecasts with their associated time
protected int	forecastPeriodInHours	maximum number of future hours to provide forecasts for
protected de.dlr.gitlab.fame.time.TimeSpan	forecastRequestOffset	offset in seconds of the MarketForecaster to send out its forecast requests to associated traders - must match the associated times -1 in the contracts with the traders
protected MarketClearing	marketClearing	the algorithm used to clear the market

Fields inherited from class de.dlr.gitlab.fame.agent.Agent

contractManager, logger

Constructor Summary

Constructors

Constructor	Description
MarketForecaster(de.dlr.gitlab.fame.agent.input.DataProvider dataProvider)	Creates a MarketForecaster

Method Summary

Modifier and Type	Method	Description
protected MarketClearingResult	getResultForRequestedTime(de.dlr.gitlab.fame.time.TimeStamp requestedTime)	Returns stored clearing result for the given time - or throws an Exception if no result is stored
protected void	saveNextForecast()	writes out the nearest upcoming forecast after current time
protected TreeMap<de.dlr.gitlab.fame.time.TimeStamp,ArrayList<de.dlr.gitlab.fame.communication.message.Message>>	sortMessagesByBidTimeStamp(ArrayList<de.dlr.gitlab.fame.communication.message.Message> messages)	Groups given messages by their targeted time of delivery into an ordered Map

Methods inherited from class de.dlr.gitlab.fame.agent.Agent

addContract, call, closeChannel, executeActions, executeWarmUp, fulfilNext, fulfilNext, getId, getNextRandomNumberGenerator, getPostOffice, handleMessage, initialiseActions, now, openChannel, publish, receive, sendMessageTo, sendMessageTo, store, store, toString, warmUp

Methods inherited from class java.lang.Object

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

Field Detail

forecastPeriodInHours

protected final int forecastPeriodInHours

maximum number of future hours to provide forecasts for

forecastRequestOffset

protected final de.dlr.gitlab.fame.time.TimeSpan forecastRequestOffset

offset in seconds of the MarketForecaster to send out its forecast requests to associated traders - must match the associated times -1 in the contracts with the traders

marketClearing

protected final MarketClearing marketClearing

the algorithm used to clear the market

calculatedForecastContainer

protected final TreeMap<de.dlr.gitlab.fame.time.TimeStamp,MarketClearingResult> calculatedForecastContainer

contains all previously calculated forecasts with their associated time

Constructor Detail

MarketForecaster

public MarketForecaster(de.dlr.gitlab.fame.agent.input.DataProvider dataProvider)
                 throws de.dlr.gitlab.fame.agent.input.ParameterData.MissingDataException

Creates a MarketForecaster

Parameters:

dataProvider - provides input from config file

Throws:

de.dlr.gitlab.fame.agent.input.ParameterData.MissingDataException - if any required data is not provided

Method Detail

sortMessagesByBidTimeStamp

protected TreeMap<de.dlr.gitlab.fame.time.TimeStamp,ArrayList<de.dlr.gitlab.fame.communication.message.Message>> sortMessagesByBidTimeStamp(ArrayList<de.dlr.gitlab.fame.communication.message.Message> messages)

Groups given messages by their targeted time of delivery into an ordered Map

Parameters:

messages - to group by

Returns:

a Map of Messages sorted by TimeStamp of the associated delivery times

getResultForRequestedTime

protected MarketClearingResult getResultForRequestedTime(de.dlr.gitlab.fame.time.TimeStamp requestedTime)

Returns stored clearing result for the given time - or throws an Exception if no result is stored

Parameters:

requestedTime - to fetch market clearing result for

Returns:

the result stored for the requested time

saveNextForecast

protected void saveNextForecast()

writes out the nearest upcoming forecast after current time