CcEnergySinkBase

Package: inet.power.base

CcEnergySinkBase

simple module

C++ definition

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

<b>See also:</b> ~CcEnergyConsumerBase, ~CcEnergySourceBase, ~CcEnergyGeneratorBase, ~CcEnergyStorageBase

Inheritance diagram

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

Extends

Name Type Description
SimpleModule simple module

Base module for all INET simple modules.

Parameters

Name Type Default value Description
displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

Properties

Name Value Description
class CcEnergySinkBase
display i=block/plug

Signals

Name Type Unit Description
currentGenerationChanged

Statistics

Name Title Source Record Unit Interpolation Mode Description
currentGeneration Current generation currentGenerationChanged vector A sample-hold

Source code

//
// This is an abstract base module for current-based energy sink models.
// It defines signals and statistics.
//
// @see ~CcEnergyConsumerBase, ~CcEnergySourceBase, ~CcEnergyGeneratorBase, ~CcEnergyStorageBase
//
simple CcEnergySinkBase extends SimpleModule like ICcEnergySink
{
    parameters:
        @class(CcEnergySinkBase);
        @display("i=block/plug");
        @signal[currentGenerationChanged];
        @statistic[currentGeneration](title="Current generation"; source=currentGenerationChanged; record=vector; interpolationmode=sample-hold; unit=A);
}

File: src/inet/power/base/CcEnergySinkBase.ned