Module Interface ICcEnergyConsumer

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

This interface extends the corresponding energy model interface. It requires implementations to describe energy consumption and energy generation with current [A], and storage capacity with charge [C] and output voltage [V]. The Cc is an abbreviation that is used for charge and current based interfaces.

See also: ICcEnergySource, ICcEnergyGenerator, ICcEnergySink, ICcEnergyStorage, ICcEnergyManagement

Author: Levente Meszaros

ICcEnergyConsumer

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
currentConsumptionChanged double

Source code:

//
// This interface extends the corresponding energy model interface. It requires
// implementations to describe energy consumption and energy generation with
// current [A], and storage capacity with charge [C] and output voltage [V].
// The Cc is an abbreviation that is used for charge and current based interfaces.
//
// @see ~ICcEnergySource, ~ICcEnergyGenerator, ~ICcEnergySink, ~ICcEnergyStorage, ~ICcEnergyManagement
// @author Levente Meszaros
//
moduleinterface ICcEnergyConsumer extends IEnergyConsumer
{
    parameters:
        @display("i=block/plug");
        @signal[currentConsumptionChanged](type=double);
}