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.

Author: Levente Meszaros

Inheritance diagram

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

Implemented by

Name	Type	Description
AlternatingEpEnergyConsumer	simple module	This energy consumer model alternates between two modes called consumption and sleep mode. In consumption mode it consumes a randomly selected constant power for a random time interval. In sleep mode it doesn't consume energy for another random time interval.
CcEnergyConsumerBase	simple module	This is an abstract base module for current based energy consumer models. It defines shared signals and statistics.
EpEnergyConsumerBase	simple module	This is an abstract base module for power based energy consumer models. It defines shared signals and statistics.
StateBasedCcEnergyConsumer	simple module	This module provides a radio energy consumer model. The current consumption is determined by the radio mode, the transmitter state and the receiver state using constant parameters.
StateBasedEpEnergyConsumer	simple module	This module provides a radio power consumer model. The power consumption is determined by the radio mode, the transmitter state and the receiver state using constant parameters.

Used in compound modules

Name	Type	Description
Radio	compound module	The radio model describes the physical device that is capable of transmitting and receiving signals on the medium. It contains an antenna model, a transmitter model, a receiver model, and an energy consumer model.

Known subclasses

Name	Type	Description
ICcEnergyConsumer	module interface	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.
IEpEnergyConsumer	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

Source code

//
// 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.
//
// @see ~IEnergySource, ~IEnergyGenerator, ~IEnergySink, ~IEnergyStorage, ~IEnergyManagement
// @author Levente Meszaros
//
moduleinterface IEnergyConsumer
{
    parameters:
        @display("i=block/plug");
}

File: src/inet/power/contract/IEnergyConsumer.ned