EpEnergyGeneratorBase

Package: inet.power.base

EpEnergyGeneratorBase

simple module

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

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

Inheritance diagram

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

Known subclasses

Name Type Description
AlternatingEpEnergyGenerator simple module

This energy generator model alternates between two modes called generation and sleep mode. In generation mode, it generates a randomly selected constant power for a random time interval. In sleep mode, it doesn't generate energy for another random time interval.

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 EpEnergyGeneratorBase
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 generator models.
// It defines shared signals and statistics.
//
// @see ~EpEnergyConsumerBase, ~EpEnergySourceBase, ~EpEnergySinkBase, ~EpEnergyStorageBase
//
simple EpEnergyGeneratorBase extends SimpleModule like IEpEnergyGenerator
{
    parameters:
        @class(EpEnergyGeneratorBase);
        @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/EpEnergyGeneratorBase.ned