Module Interface IEpEnergySink

Package: inet.power.contract
File: src/inet/power/contract/IEpEnergySink.ned

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.

See also: IEpEnergyConsumer, IEpEnergySource, IEpEnergyGenerator, IEpEnergyStorage, IEpEnergyManagement

Author: Levente Meszaros

IEpEnergySink

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends:

Name Type Description
IEnergySink module interface

The energy sink models absorb energy from multiple energy generators.

Known subclasses:

Name Type Description
IEpEnergyStorage 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.

Properties:

Name Value Description
display i=block/plug

Signals:

Name Type Unit
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 Ep is an abbreviation
// that is used for energy and power based interfaces.
//
// @see ~IEpEnergyConsumer, ~IEpEnergySource, ~IEpEnergyGenerator, ~IEpEnergyStorage, ~IEpEnergyManagement
// @author Levente Meszaros
//
moduleinterface IEpEnergySink extends IEnergySink
{
    parameters:
        @display("i=block/plug");
        @signal[powerGenerationChanged](type=double);
}