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.

Inheritance diagram

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

Implemented by

Name	Type	Description
CcEnergySinkBase	simple module	This is an abstract base module for current based energy sink models. It defines signals and statistics.
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.

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.

Extends

Name	Type	Description
IEnergySink	module interface	The energy sink models absorb energy from multiple energy generators.

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
//
moduleinterface ICcEnergySink extends IEnergySink
{
    parameters:
        @display("i=block/plug");
        @signal[currentGenerationChanged](type=double);
}

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