Class BidData


  • public class BidData
    extends de.dlr.gitlab.fame.communication.message.DataItem
    Transfers a Bid
    • Constructor Summary

      Constructors 
      Constructor Description
      BidData​(double offeredEnergyInMWH, double priceInEURperMWH, double marginalCostInEURperMWH, double powerPotentialInMW, long traderUuid, long producerUuid, Bid.Type type, de.dlr.gitlab.fame.time.TimeStamp deliveryTime)  
      BidData​(double offeredEnergyInMWH, double priceInEURperMWH, double marginalCostInEURperMWH, long traderUuid, Bid.Type type, de.dlr.gitlab.fame.time.TimeStamp deliveryTime)
      Constructs a new BidData; producerUuid = -1; powerPotential = Double.NaN
      BidData​(double offeredEnergyInMWH, double priceInEURperMWH, long traderUuid, Bid.Type type, de.dlr.gitlab.fame.time.TimeStamp deliveryTime)
      Constructs a new BidData; using producerUuid = -1; marginalCost = powerPotential = Double.NaN
      BidData​(de.dlr.gitlab.fame.protobuf.Agent.ProtoDataItem proto)
      Mandatory for deserialisation of DataItems
    • Field Detail

      • BY_PRICE_ASCENDING

        public static final Comparator<BidData> BY_PRICE_ASCENDING
        Compares two BidData objects with respect to their bidding price (ascending)
      • offeredEnergyInMWH

        public final double offeredEnergyInMWH
        the amount of offered energy
      • priceInEURperMWH

        public final double priceInEURperMWH
        the bid price
      • marginalCostInEURperMWH

        public final double marginalCostInEURperMWH
        the marginal cost information of the producer resp. plant segment
      • powerPotentialInMW

        public final double powerPotentialInMW
        the actual (perfect foresight) power potential of a supplier
      • traderUuid

        public final long traderUuid
        the unique Id of the trader
      • producerUuid

        public final long producerUuid
        the unique Id of the power plant operator
      • type

        public final Bid.Type type
        the bid type (demand or supply)
      • deliveryTime

        public final de.dlr.gitlab.fame.time.TimeStamp deliveryTime
        the begin of the delivery interval
    • Constructor Detail

      • BidData

        public BidData​(double offeredEnergyInMWH,
                       double priceInEURperMWH,
                       long traderUuid,
                       Bid.Type type,
                       de.dlr.gitlab.fame.time.TimeStamp deliveryTime)
        Constructs a new BidData; using producerUuid = -1; marginalCost = powerPotential = Double.NaN
        Parameters:
        offeredEnergyInMWH - this bids offered energy (either asked for as offered in MWh
        priceInEURperMWH - this bids price in EUR per MWh
        traderUuid - unique ID of the trader associated with this bid
        type - Bid.Type of the bid, either Bid.Type.Demand or Bid.Type.Supply
        deliveryTime - the starting time at which the associated energy is to be delivered
      • BidData

        public BidData​(double offeredEnergyInMWH,
                       double priceInEURperMWH,
                       double marginalCostInEURperMWH,
                       long traderUuid,
                       Bid.Type type,
                       de.dlr.gitlab.fame.time.TimeStamp deliveryTime)
        Constructs a new BidData; producerUuid = -1; powerPotential = Double.NaN
        Parameters:
        offeredEnergyInMWH - this bids offered energy (either asked for as offered in MWh
        priceInEURperMWH - this bids price in EUR per MWh
        marginalCostInEURperMWH - the true marginal cost for producing the offered energy
        traderUuid - unique ID of the trader associated with this bid
        type - Bid.Type of the bid, either Bid.Type.Demand or Bid.Type.Supply
        deliveryTime - the starting time at which the associated energy is to be delivered
      • BidData

        public BidData​(double offeredEnergyInMWH,
                       double priceInEURperMWH,
                       double marginalCostInEURperMWH,
                       double powerPotentialInMW,
                       long traderUuid,
                       long producerUuid,
                       Bid.Type type,
                       de.dlr.gitlab.fame.time.TimeStamp deliveryTime)
        Parameters:
        offeredEnergyInMWH - this bids offered energy (either asked for as offered in MWh
        priceInEURperMWH - this bids price in EUR per MWh
        marginalCostInEURperMWH - the true marginal cost for producing the offered energy in EUR per MWh
        powerPotentialInMW - the true power that the associated generation unit could produce in perfect foresight
        traderUuid - unique ID of the trader associated with this bid
        producerUuid - the unique ID of the associated generation unit
        type - Bid.Type of the bid, either Bid.Type.Demand or Bid.Type.Supply
        deliveryTime - the starting time at which the associated energy is to be delivered
      • BidData

        public BidData​(de.dlr.gitlab.fame.protobuf.Agent.ProtoDataItem proto)
        Mandatory for deserialisation of DataItems
        Parameters:
        proto - protobuf representation
    • Method Detail

      • fillDataFields

        protected void fillDataFields​(de.dlr.gitlab.fame.protobuf.Agent.ProtoDataItem.Builder builder)
        Specified by:
        fillDataFields in class de.dlr.gitlab.fame.communication.message.DataItem
      • getBid

        public Bid getBid()
        Returns:
        Bid equivalent to this BidData