Package communications.message
Class TransmissionCapacity
- java.lang.Object
-
- communications.message.TransmissionCapacity
-
- All Implemented Interfaces:
de.dlr.gitlab.fame.communication.transfer.Portable
,Cloneable
public class TransmissionCapacity extends Object implements de.dlr.gitlab.fame.communication.transfer.Portable, Cloneable
Specifies a transmission capacity of electricity from one market zone to another.- Author:
- A. Achraf El Ghazi, Felix Nitsch
-
-
Constructor Summary
Constructors Constructor Description TransmissionCapacity()
required forPortable
sTransmissionCapacity(String target, double amount)
Constructs a newTransmissionCapacity
object based on:
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addComponentsTo(de.dlr.gitlab.fame.communication.transfer.ComponentCollector collector)
TransmissionCapacity
clone()
double
getRemainingTransferCapacityInMW()
String
getTarget()
void
populate(de.dlr.gitlab.fame.communication.transfer.ComponentProvider provider)
void
setRemainingTransferCapacityInMW(double newRemainingTransferCapacityInMW)
updates remaining transfer capacity to the given value
-
-
-
Constructor Detail
-
TransmissionCapacity
public TransmissionCapacity()
required forPortable
s
-
TransmissionCapacity
public TransmissionCapacity(String target, double amount)
Constructs a newTransmissionCapacity
object based on:- Parameters:
target
- market zone nameamount
- of energy that can be maximally transfered from origin to target market zone
-
-
Method Detail
-
addComponentsTo
public void addComponentsTo(de.dlr.gitlab.fame.communication.transfer.ComponentCollector collector)
- Specified by:
addComponentsTo
in interfacede.dlr.gitlab.fame.communication.transfer.Portable
-
populate
public void populate(de.dlr.gitlab.fame.communication.transfer.ComponentProvider provider)
- Specified by:
populate
in interfacede.dlr.gitlab.fame.communication.transfer.Portable
-
clone
public TransmissionCapacity clone()
-
getTarget
public String getTarget()
- Returns:
- market zone that is the target of the transmission
-
getRemainingTransferCapacityInMW
public double getRemainingTransferCapacityInMW()
- Returns:
- remaining amount of energy that can be transferred to the target market zone
-
setRemainingTransferCapacityInMW
public void setRemainingTransferCapacityInMW(double newRemainingTransferCapacityInMW)
updates remaining transfer capacity to the given value- Parameters:
newRemainingTransferCapacityInMW
- to be used as new value
-
-