Package agents.markets

Interface FuelsTrader

All Superinterfaces:

de.dlr.gitlab.fame.agent.AgentAbility

All Known Implementing Classes:

ConventionalPlantOperator, ElectrolysisTrader, GreenHydrogenTrader, GreenHydrogenTraderMonthly

public interface FuelsTrader
extends de.dlr.gitlab.fame.agent.AgentAbility

Interface for traders at the FuelsMarket

Author:

Christoph Schimeczek

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FuelsTrader.Products	Products of traders interacting with FuelsMarket

Field Summary

Fields

Modifier and Type	Field	Description
static de.dlr.gitlab.fame.agent.input.ParameterBuilder	fuelTypeParameter	Name for fuel type input parameter harmonised across agents related to fuels trading

Method Summary

Modifier and Type	Method	Description
default double	readFuelBillMessage(de.dlr.gitlab.fame.communication.message.Message message)	Reads a FuelsMarket.Products.FuelBill message from a contracted FuelsMarket
default FuelCost	readFuelPriceMessage(de.dlr.gitlab.fame.communication.message.Message message)	Reads a FuelsMarket.Products.FuelPriceForecast or FuelsMarket.Products.FuelPrice message from a contracted FuelsMarket
static String	readFuelType(de.dlr.gitlab.fame.agent.input.ParameterData input)
default void	sendFuelBid(de.dlr.gitlab.fame.communication.Contract contract, FuelBid fuelBid)	Send a FuelsTrader.Products.FuelBid message to the contracted FuelsMarket
default void	sendFuelPriceRequest(de.dlr.gitlab.fame.communication.Contract contract, FuelData fuelData, ClearingTimes clearingTimes)	Send a FuelsTrader.Products.FuelPriceForecastRequest or FuelsTrader.Products.FuelPriceRequest message to the contracted FuelsMarket

Methods inherited from interface de.dlr.gitlab.fame.agent.AgentAbility

call, fulfilNext, fulfilNext, getId, getNextRandomNumberGenerator, now, store, store

Field Detail

fuelTypeParameter

static final de.dlr.gitlab.fame.agent.input.ParameterBuilder fuelTypeParameter

Name for fuel type input parameter harmonised across agents related to fuels trading

Method Detail

readFuelType

static String readFuelType(de.dlr.gitlab.fame.agent.input.ParameterData input)
                    throws de.dlr.gitlab.fame.agent.input.ParameterData.MissingDataException

Parameters:

input - group with a fuel type input parameter

Returns:

fuelType read from given input parameter group

Throws:

de.dlr.gitlab.fame.agent.input.ParameterData.MissingDataException - if fuel type input is missing

sendFuelPriceRequest

default void sendFuelPriceRequest(de.dlr.gitlab.fame.communication.Contract contract,
                                  FuelData fuelData,
                                  ClearingTimes clearingTimes)

Send a FuelsTrader.Products.FuelPriceForecastRequest or FuelsTrader.Products.FuelPriceRequest message to the contracted FuelsMarket

Parameters:

contract - with the FuelsMarket

fuelData - specifies for which type of fuel price (forecasts) are requested

clearingTimes - specifies at which time(s) price (forecasts) are requested

readFuelPriceMessage

default FuelCost readFuelPriceMessage(de.dlr.gitlab.fame.communication.message.Message message)

Reads a FuelsMarket.Products.FuelPriceForecast or FuelsMarket.Products.FuelPrice message from a contracted FuelsMarket

Parameters:

message - to be read

Returns:

FuelCost extracted from the message

sendFuelBid

default void sendFuelBid(de.dlr.gitlab.fame.communication.Contract contract,
                         FuelBid fuelBid)

Send a FuelsTrader.Products.FuelBid message to the contracted FuelsMarket

Parameters:

contract - with the FuelsMarket

fuelBid - to be sent

readFuelBillMessage

default double readFuelBillMessage(de.dlr.gitlab.fame.communication.message.Message message)

Reads a FuelsMarket.Products.FuelBill message from a contracted FuelsMarket

Parameters:

message - to be read

Returns:

total cost for fuel in last FuelBid message (negative on revenues)