EpEnergySinkBase

Package: inet.power.base

EpEnergySinkBase

simple module

C++ definition

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

<b>See also:</b> ~EpEnergyConsumerBase, ~EpEnergySourceBase, ~EpEnergyGeneratorBase, ~EpEnergyStorageBase

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 EpEnergySinkBase
display i=block/plug

Signals

Name Type Unit Description
powerGenerationChanged

Statistics

Name Title Source Record Unit Interpolation Mode Description
powerGeneration Power generation powerGenerationChanged vector W sample-hold

Source code

//
// This is an abstract base module for power-based energy sink models.
// It defines signals and statistics.
//
// @see ~EpEnergyConsumerBase, ~EpEnergySourceBase, ~EpEnergyGeneratorBase, ~EpEnergyStorageBase
//
simple EpEnergySinkBase extends SimpleModule like IEpEnergySink
{
    parameters:
        @class(EpEnergySinkBase);
        @display("i=block/plug");
        @signal[powerGenerationChanged];
        @statistic[powerGeneration](title="Power generation"; source=powerGenerationChanged; record=vector; interpolationmode=sample-hold; unit=W);
}

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