Module Interface ICcEnergySink

Package: inet.power.contract
File: src/inet/power/contract/ICcEnergySink.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: ICcEnergyConsumer, ICcEnergySource, ICcEnergyGenerator, ICcEnergyStorage, ICcEnergyManagement

Author: Levente Meszaros

ICcEnergySink

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

Properties:

Name Value Description
display i=block/plug

Signals:

Name Type Unit
currentGenerationChanged 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, ~ICcEnergyStorage, ~ICcEnergyManagement
// @author Levente Meszaros
//
moduleinterface ICcEnergySink extends IEnergySink
{
    parameters:
        @display("i=block/plug");
        @signal[currentGenerationChanged](type=double);
}