CcEnergyConsumerBase

Package: inet.power.base

simple module CcEnergyConsumerBase

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

See also: CcEnergySourceBase, CcEnergyGeneratorBase, CcEnergySinkBase, CcEnergyStorageBase

inet.power.base.CcEnergyConsumerBaseCcEnergyConsumerBasesimple

Inheritance 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

CcEnergyConsumerBase

display

i=block/plug

Signals

Name

Type

Unit

Description

currentConsumptionChanged

double

Statistics

Name

Title

Source

Record

Unit

Interpolation Mode

Description

currentConsumption

Current consumption

currentConsumptionChanged

vector

A

sample-hold

Source code

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

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