Package communications.message

Class YieldPotential

java.lang.Object

de.dlr.gitlab.fame.communication.message.DataItem

communications.message.PointInTime

communications.message.AmountAtTime

communications.message.YieldPotential

public class YieldPotential
extends AmountAtTime

Yield potential data associated with an energy carrier

Author:

Johannes Kochems

Field Summary

Fields

Modifier and Type	Field	Description
SupportPolicy.EnergyCarrier	energyCarrier	the energy carrier

Fields inherited from class communications.message.AmountAtTime

amount

Fields inherited from class communications.message.PointInTime

validAt

Fields inherited from class de.dlr.gitlab.fame.communication.message.DataItem

CLASS_NOT_KNOWN, ERR_MISSING_CONSTRUCTOR

Constructor Summary

Constructors

Constructor	Description
YieldPotential(de.dlr.gitlab.fame.protobuf.Agent.ProtoDataItem proto)	Mandatory for deserialisation of DataItems
YieldPotential(de.dlr.gitlab.fame.time.TimeStamp timeStamp, double amount, SupportPolicy.EnergyCarrier energyCarrier)	Create new YieldPotential

Method Summary

Modifier and Type	Method	Description
protected void	fillDataFields(de.dlr.gitlab.fame.protobuf.Agent.ProtoDataItem.Builder builder)

Methods inherited from class de.dlr.gitlab.fame.communication.message.DataItem

getProtobuf

Methods inherited from class java.lang.Object

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

Field Detail

energyCarrier

public final SupportPolicy.EnergyCarrier energyCarrier

the energy carrier

Constructor Detail

YieldPotential

public YieldPotential(de.dlr.gitlab.fame.time.TimeStamp timeStamp,
                      double amount,
                      SupportPolicy.EnergyCarrier energyCarrier)

Create new YieldPotential

Parameters:

timeStamp - at which the electricity could be produced

amount - of electricity that could be produced in MWh

energyCarrier - used for the electricity production

YieldPotential

public YieldPotential(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)

Overrides:

fillDataFields in class AmountAtTime