IEnergyGenerator

Package: inet.power.contract

module interface IEnergyGenerator

The energy generator models describe the energy generation process of devices over time. A solar panel, for example, produces energy based on time, the panel’s position on the globe, its orientation towards the sun, and the actual weather conditions.

See also: IEnergyConsumer, IEnergySource, IEnergySink, IEnergyStorage, IEnergyManagement

Usage diagram

Inheritance diagram

Implemented by

Name

Type

Description

CcEnergyGeneratorBase

simple module

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

EpEnergyGeneratorBase

simple module

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

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.

Used in compound modules

Name

Type

Description

NodeBase

compound module

The fundamental infrastructure for all network nodes focusing on non-communication aspects of network nodes.

Known subclasses

Name

Type

Description

ICcEnergyGenerator

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.

IEpEnergyGenerator

module interface

This interface extends the corresponding energy model interface. It requires implementations to describe energy consumption and energy generation with power [W] and storage capacity with energy [J]. The Ep is an abbreviation that is used for energy and power-based interfaces.

Properties

Name

Value

Description

display

i=block/plug

Source code

//
// The energy generator models describe the energy generation process of devices
// over time. A solar panel, for example, produces energy based on time, the
// panel's position on the globe, its orientation towards the sun, and the actual
// weather conditions.
//
// @see ~IEnergyConsumer, ~IEnergySource, ~IEnergySink, ~IEnergyStorage, ~IEnergyManagement
//
moduleinterface IEnergyGenerator
{
    parameters:
        @display("i=block/plug");
}

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