SimpleEpEnergyStorage

simple module

This energy storage model maintains a residual energy capacity by integrating the difference between the total consumed power and the total generated power over time. It initiates node crash when the residual energy capacity reaches zero. This model doesn't have various properties such as self-discharge, memory effect, overcharging, temperature-dependence, etc. that real world batteries have. See the base module for signals and statistics.

See also: SimpleEpEnergyManagement

Inheritance diagram

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

Extends

Name	Type	Description
EpEnergyStorageBase	simple module	This is an abstract base module for power based energy storage models. It defines shared signals and statistics.

Parameters

Name	Type	Default value	Description
nominalCapacity	double		the maximum amount of energy stored
initialCapacity	double	nominalCapacity	the initially stored amount of energy
printCapacityStep	double	0.01 * nominalCapacity	displays residual capacity changes in the log
displayStringTextFormat	string	"%c (%p)"

Properties

Name	Value	Description
display	i=block/plug
class	SimpleEpEnergyStorage

Signals

Name	Type	Unit
residualEnergyCapacityChanged
powerConsumptionChanged
powerGenerationChanged

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
residualEnergyCapacity	Residual energy capacity	residualEnergyCapacityChanged	vector, last	J	linear
powerConsumption	Power consumption	powerConsumptionChanged	vector	W	sample-hold
powerGeneration	Power generation	powerGenerationChanged	vector	W	sample-hold

Scheduled messages (observed)

msg	kind	ctrl	tags	msgname	context
omnetpp::cMessage	0			timer

Direct method calls (observed)

call to	function	info
PingApp	inet::PingApp::handleOperationStage	handleOperationStage
NodeStatus	inet::NodeStatus::handleOperationStage	handleOperationStage
Ieee80211Interface	inet::NetworkInterface::handleOperationStage	handleOperationStage
Ieee80211LlcLpd	inet::ieee80211::Ieee80211LlcLpd::handleOperationStage	handleOperationStage
Ieee80211Mac	inet::ieee80211::Ieee80211Mac::handleOperationStage	handleOperationStage
Ieee80211MgmtAdhoc	inet::ieee80211::Ieee80211MgmtAdhoc::handleOperationStage	handleOperationStage
Loopback	inet::Loopback::handleOperationStage	handleOperationStage
LoopbackInterface	inet::NetworkInterface::handleOperationStage	handleOperationStage
Arp	inet::Arp::handleOperationStage	handleOperationStage
InterfaceTable	inet::InterfaceTable::handleOperationStage	handleOperationStage
Ipv4NodeConfigurator	inet::Ipv4NodeConfigurator::handleOperationStage	handleOperationStage
Ipv4	inet::Ipv4::handleOperationStage	handleOperationStage
Ipv4RoutingTable	inet::Ipv4RoutingTable::handleOperationStage	handleOperationStage
Ieee80211ScalarRadio	inet::physicallayer::Ieee80211Radio::handleOperationStage	handleOperationStage
SimpleEpEnergyManagement	inet::power::SimpleEpEnergyManagement::receiveSignal	powerConsumptionChanged
SimpleEpEnergyManagement	inet::power::SimpleEpEnergyManagement::receiveSignal	powerGenerationChanged
Tcp	inet::tcp::Tcp::handleOperationStage	handleOperationStage
Udp	inet::Udp::handleOperationStage	handleOperationStage

Called methods (observed)

function	info	call from
inet::power::SimpleEpEnergyStorage::addEnergyConsumer	addEnergyConsumer	StateBasedEpEnergyConsumer
inet::power::SimpleEpEnergyStorage::addEnergyGenerator	addEnergyGenerator	AlternatingEpEnergyGenerator
inet::power::SimpleEpEnergyStorage::receiveSignal	powerConsumptionChanged	StateBasedEpEnergyConsumer
inet::power::SimpleEpEnergyStorage::receiveSignal	powerGenerationChanged	AlternatingEpEnergyGenerator

Source code

//
// This energy storage model maintains a residual energy capacity by integrating
// the difference between the total consumed power and the total generated power
// over time. It initiates node crash when the residual energy capacity reaches
// zero. This model doesn't have various properties such as self-discharge, memory
// effect, overcharging, temperature-dependence, etc. that real world batteries
// have. See the base module for signals and statistics.
//
// @see ~SimpleEpEnergyManagement
//
simple SimpleEpEnergyStorage extends EpEnergyStorageBase
{
    parameters:
        double nominalCapacity @unit(J); // the maximum amount of energy stored
        double initialCapacity @unit(J) = default(nominalCapacity); // the initially stored amount of energy
        double printCapacityStep @unit(J) = default(0.01 * nominalCapacity); // displays residual capacity changes in the log
        string displayStringTextFormat = default("%c (%p)");
        @class(SimpleEpEnergyStorage);
}

File: src/inet/power/storage/SimpleEpEnergyStorage.ned