Module Interface IEpEnergyConsumer

Package: inet.power.contract
File: src/inet/power/contract/IEpEnergyConsumer.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: IEpEnergySource, IEpEnergyGenerator, IEpEnergySink, IEpEnergyStorage, IEpEnergyManagement

Author: Levente Meszaros

IEpEnergyConsumer

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
IEnergyConsumer module interface

The energy consumer models describe the energy consumption process of devices over time. For example, a radio consumes energy when it transmits or receives signals, or a CPU consumes energy when the network layer processes packets, or a display consumes energy when it's turned on, etc.

Properties:

Name Value Description
display i=block/plug

Signals:

Name Type Unit
powerConsumptionChanged 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 ~IEpEnergySource, ~IEpEnergyGenerator, ~IEpEnergySink, ~IEpEnergyStorage, ~IEpEnergyManagement
// @author Levente Meszaros
//
moduleinterface IEpEnergyConsumer extends IEnergyConsumer
{
    parameters:
        @display("i=block/plug");
        @signal[powerConsumptionChanged](type=double);
}