Marginal (amiris-core 3.1.0 API)

java.lang.Object
- agents.plantOperator.Marginal

All Implemented Interfaces:

de.dlr.gitlab.fame.communication.transfer.Portable
```
public class Marginal
extends Object
implements de.dlr.gitlab.fame.communication.transfer.Portable
```
Transmits a single power-marginalCost pair

Author:

Christoph Schimeczek

Field Summary

Fields
Modifier and Type Field Description

static Comparator<Marginal> byCostAscending
Sorts by costs in ascending order

Constructor Summary

Constructors
Constructor Description

Marginal()
required for Portables

Marginal(double powerPotentialInMW, double marginalCostInEURperMWH)
Constructs new Marginal

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addComponentsTo(de.dlr.gitlab.fame.communication.transfer.ComponentCollector collector)`
`double`	`getMarginalCostInEURperMWH()`
`double`	`getPowerPotentialInMW()`
`void`	`populate(de.dlr.gitlab.fame.communication.transfer.ComponentProvider provider)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - byCostAscending
```
public static Comparator<Marginal> byCostAscending
```
    Sorts by costs in ascending order
- Constructor Detail
  - Marginal
```
public Marginal()
```
    required for Portables
  - Marginal
```
public Marginal(double powerPotentialInMW,
                double marginalCostInEURperMWH)
```
    Constructs new Marginal
    
    Parameters:
    
    powerPotentialInMW - true power production potential by electricity generation unit in MW
    
    marginalCostInEURperMWH - marginal power production costs in EUR per MWh
- 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
  - getPowerPotentialInMW
```
public double getPowerPotentialInMW()
```
    Returns:
    
    the actual power potential
  - getMarginalCostInEURperMWH
```
public double getMarginalCostInEURperMWH()
```
    Returns:
    
    the actual marginal cost value