Class CouplingData

  • All Implemented Interfaces:
    de.dlr.gitlab.fame.communication.transfer.Portable, Cloneable

    public class CouplingData
    extends Object
    implements de.dlr.gitlab.fame.communication.transfer.Portable, Cloneable
    Specifies the data that EnergyExchange agents have to send to the MarketCoupling agent in order to minimise price variance across markets. The same data type is return from the MarketCoupling agent to the registered EnergyExchange(s).
    Author:
    A. Achraf El Ghazi, Felix Nitsch
    • Constructor Detail

      • CouplingData

        public CouplingData()
        required for Portables
      • CouplingData

        public CouplingData​(DemandOrderBook demandOrderBook,
                            SupplyOrderBook supplyOrderBook,
                            TransmissionBook transmissionBook)
        Create a CouplingData object
        Parameters:
        demandOrderBook - of the demand bids
        supplyOrderBook - of the supply bids
        transmissionBook - of the transmission capacities
    • Method Detail

      • addComponentsTo

        public void addComponentsTo​(de.dlr.gitlab.fame.communication.transfer.ComponentCollector collector)
        Specified by:
        addComponentsTo in interface de.dlr.gitlab.fame.communication.transfer.Portable
      • populate

        public void populate​(de.dlr.gitlab.fame.communication.transfer.ComponentProvider provider)
        Specified by:
        populate in interface de.dlr.gitlab.fame.communication.transfer.Portable
      • getDemandOrderBook

        public DemandOrderBook getDemandOrderBook()
        Returns:
        the demandOrderBook of this object
      • setDemandOrderBook

        public void setDemandOrderBook​(DemandOrderBook demandOrderBook)
        Sets demandOrderBook of this object with
        Parameters:
        demandOrderBook - to set
      • getSupplyOrderBook

        public SupplyOrderBook getSupplyOrderBook()
        Returns:
        the supplyOrderBook of this object
      • setSupplyOrderBook

        public void setSupplyOrderBook​(SupplyOrderBook supplyOrderBook)
        Sets supplyOrderBook of this object with
        Parameters:
        supplyOrderBook - to set
      • getTransmissionBook

        public TransmissionBook getTransmissionBook()
        Returns:
        the transmissionBook of this object
      • getTransmissionTo

        public double getTransmissionTo​(String target)
        Parameters:
        target - Region
        Returns:
        the transmission capacity amount from this market's region to the given target Region
      • setTransmissionBook

        public void setTransmissionBook​(TransmissionBook transmissionBook)
        Sets transmissionBook of this object with
        Parameters:
        transmissionBook - to set
      • updateTransmissionBook

        public void updateTransmissionBook​(String region,
                                           double amount)
        updates transmissionBook of this object with the given amount for the given Region
        Parameters:
        region - to update
        amount - to update with
      • getImportOrderBook

        public TransferOrderBook getImportOrderBook()
        Returns:
        the importOrderBook of this object
      • setImportOrderBook

        public void setImportOrderBook​(TransferOrderBook importOrderBook)
        Sets importOrderBook of this object
        Parameters:
        importOrderBook - to set
      • updateImportBook

        public void updateImportBook​(TransferOrderBook transferOrderBook)
        Updates the importOrderBook of this object with
        Parameters:
        transferOrderBook - to update with
      • getExportOrderBook

        public TransferOrderBook getExportOrderBook()
        Returns:
        the exportOrderBook of this object
      • setExportOrderBook

        public void setExportOrderBook​(TransferOrderBook exportOrderBook)
        Sets exportOrderBook of this object with
        Parameters:
        exportOrderBook - to set
      • updateExportBook

        public void updateExportBook​(TransferOrderBook transferOrderBook)
        Updates the exportOrderBook of this object with
        Parameters:
        transferOrderBook - to update with
      • clone

        public CouplingData clone()
        Overrides:
        clone in class Object
        Returns:
        a deep copy of CouplingRequest caller
      • getOrigin

        public String getOrigin()
        Returns:
        origin Region of this CouplingData