ICcEnergyStorage

Package: inet.power.contract

ICcEnergyStorage

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.

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

Inheritance diagram

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

Implemented by

Name Type Description
CcBatteryPack simple module (no description)
CcEnergyStorageBase simple module

This is an abstract base module for current based energy storage models. It defines shared signals and statistics.

SimpleCcBattery simple module

This battery model maintains a residual charge capacity by integrating the difference between the total consumed current and the total generated current over time. This model uses a charge independent ideal voltage source and an charge independent internal resistance. It initiates node crash when the residual charge capacity reaches zero. See the base module for signals and statistics.

Extends

Name Type Description
IEnergyStorage module interface

The energy storage models describe devices that absorb energy produced by generators, and provide energy for consumers. For example, an electrochemical battery in a mobile phone provides energy for its display, its CPU, and its wireless communication device. It can also absorb energy produced by a solar panel installed on its display, or by a portable charger plugged into a wall socket.

ICcEnergySink 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.

ICcEnergySource 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.

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 ~ICcEnergyConsumer, ~ICcEnergySource, ~ICcEnergyGenerator, ~ICcEnergySink, ~ICcEnergyManagement
//
moduleinterface ICcEnergyStorage extends ICcEnergySource, ICcEnergySink, IEnergyStorage
{
    parameters:
        @display("i=block/plug");
        @signal[residualChargeCapacityChanged](type=double);
}

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