IEpEnergySink¶
Package: inet.power.contract
module interface IEpEnergySink
This interface extends the corresponding energy model interface. It requires implementations to describe energy consumption and energy generation with power [W] and storage capacity with energy [J]. The abbreviation Ep is used for energy and power based interfaces.
See also: IEpEnergyConsumer, IEpEnergySource, IEpEnergyGenerator, IEpEnergyStorage, IEpEnergyManagement
Inheritance diagram¶
Implemented by¶
Name |
Type |
Description |
|---|---|---|
simple module |
This is an abstract base module for power-based energy sink models. It defines signals and statistics. |
|
simple module |
This is an abstract base module for power-based energy storage models. It defines shared signals and statistics. |
|
simple module |
This energy storage model stores an infinite amount of energy. It can provide energy for any number of consumers, and it can absorb energy from any number of generators. The ideal energy storage never gets completely charged or depleted. This module is primarily useful for testing energy consumer and energy generator models. See the base module for signals and statistics. |
|
simple module |
This energy storage model maintains a residual energy capacity by integrating the difference between the total consumed power and the total generated power over time. It initiates node crash when the residual energy capacity reaches zero. This model does not have various properties such as self-discharge, memory effect, overcharging, temperature-dependence, etc. that real-world batteries have. See the base module for signals and statistics. |
Known subclasses¶
Name |
Type |
Description |
|---|---|---|
module interface |
This interface extends the corresponding energy model interface. It requires implementations to describe energy consumption and energy generation with power [W] and storage capacity with energy [J]. The Ep is an abbreviation that is used for energy and power-based interfaces. |
Extends¶
Name |
Type |
Description |
|---|---|---|
module interface |
The energy sink models absorbs energy from multiple energy generators. |
Properties¶
Name |
Value |
Description |
|---|---|---|
display |
i=block/plug |
Signals¶
Name |
Type |
Unit |
Description |
|---|---|---|---|
powerGenerationChanged |
double |
Source code¶
//
// This interface extends the corresponding energy model interface. It requires
// implementations to describe energy consumption and energy generation with
// power [W] and storage capacity with energy [J]. The abbreviation Ep is used
// for energy and power based interfaces.
//
// @see ~IEpEnergyConsumer, ~IEpEnergySource, ~IEpEnergyGenerator, ~IEpEnergyStorage, ~IEpEnergyManagement
//
moduleinterface IEpEnergySink extends IEnergySink
{
parameters:
@display("i=block/plug");
@signal[powerGenerationChanged](type=double);
}