inet::power::SimpleCcBattery Class Reference

#include <SimpleCcBattery.h>

Inheritance diagram for inet::power::SimpleCcBattery:

Public Member Functions
virtual V	getNominalVoltage () const override
	Returns the open circuit voltage in the range [0, +infinity). More...
virtual V	getOutputVoltage () const override
	Returns the output voltage in the ragne [0, +infinity). More...
virtual A	getTotalCurrentConsumption () const override
	Returns the total current consumption in the range [0, +infinity). More...
virtual A	getTotalCurrentGeneration () const override
	Returns the total current generation in the range [0, +infinity). More...
virtual C	getNominalChargeCapacity () const override
	Returns the nominal charge capacity in the range [0, +infinity). More...
virtual C	getResidualChargeCapacity () const override
	Returns the residual charge capacity in the range [0, nominalCapacity]. More...
Public Member Functions inherited from inet::power::CcEnergyStorageBase
virtual void	addEnergyConsumer (const IEnergyConsumer *energyConsumer) override
	Adds a new energy consumer to the energy source. More...
virtual void	removeEnergyConsumer (const IEnergyConsumer *energyConsumer) override
	Removes a previously added energy consumer from this energy source. More...
virtual void	addEnergyGenerator (const IEnergyGenerator *energyGenerator) override
	Adds a new energy generator to the energy sink. More...
virtual void	removeEnergyGenerator (const IEnergyGenerator *energyGenerator) override
	Removes a previously added energy generator from this energy sink. More...
virtual void	receiveSignal (cComponent *source, simsignal_t signal, double value, cObject *details) override
Public Member Functions inherited from inet::power::EnergySourceBase
virtual int	getNumEnergyConsumers () const override
	Returns the number of energy consumers in the range [0, +infinity). More...
virtual const IEnergyConsumer *	getEnergyConsumer (int index) const override
	Returns the energy consumer for the provided index. More...
Public Member Functions inherited from inet::power::IEnergySource
virtual	~IEnergySource ()
Public Member Functions inherited from inet::power::EnergySinkBase
virtual int	getNumEnergyGenerators () const override
	Returns the number of energy generators in the range [0, +infinity). More...
virtual const IEnergyGenerator *	getEnergyGenerator (int index) const override
	Returns the energy generator for the provided index. More...
Public Member Functions inherited from inet::power::IEnergySink
virtual	~IEnergySink ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	updateTotalCurrentConsumption () override
virtual void	updateTotalCurrentGeneration () override
virtual void	setResidualCapacity (C newResidualCapacity)
virtual void	updateResidualCapacity ()
virtual void	executeNodeOperation (C newResidualCapacity)
Protected Member Functions inherited from inet::power::CcEnergyStorageBase
void	initialize (int stage) override
Protected Member Functions inherited from inet::power::CcEnergySourceBase
virtual A	computeTotalCurrentConsumption () const
Protected Member Functions inherited from inet::power::CcEnergySinkBase
virtual A	computeTotalCurrentGeneration () const

Protected Attributes
C	nominalCapacity = C(NaN)
V	nominalVoltage = V(NaN)
Ohm	internalResistance = Ohm(NaN)
C	residualCapacity = C(NaN)
simtime_t	lastResidualCapacityUpdate = -1
LifecycleController *	lifecycleController = nullptr
cModule *	networkNode = nullptr
NodeStatus *	nodeStatus = nullptr
Protected Attributes inherited from inet::power::CcEnergySourceBase
A	totalCurrentConsumption = A(NaN)
Protected Attributes inherited from inet::power::EnergySourceBase
std::vector< const IEnergyConsumer * >	energyConsumers
Protected Attributes inherited from inet::power::CcEnergySinkBase
A	totalCurrentGeneration = A(NaN)
Protected Attributes inherited from inet::power::EnergySinkBase
std::vector< const IEnergyGenerator * >	energyGenerators

Additional Inherited Members
Static Public Attributes inherited from inet::power::ICcEnergySource
static simsignal_t	currentConsumptionChangedSignal = cComponent::registerSignal("currentConsumptionChanged")
	The signal that is used to publish current consumption changes. More...
Static Public Attributes inherited from inet::power::ICcEnergySink
static simsignal_t	currentGenerationChangedSignal = cComponent::registerSignal("currentGenerationChanged")
	The signal that is used to publish current generation changes. More...
Static Public Attributes inherited from inet::power::ICcEnergyStorage
static simsignal_t	residualChargeCapacityChangedSignal = cComponent::registerSignal("residualChargeCapacityChanged")
	The signal that is used to publish residual charge capacity changes also including when the energy storage becomes completely depleted or charged. More...

Member Function Documentation

void inet::power::SimpleCcBattery::executeNodeOperation ( C  newResidualCapacity )

protectedvirtual

Referenced by setResidualCapacity().

{
    if (nodeStatus->getState() == NodeStatus::UP && newResidualCapacity <= C(0)) {
        EV_WARN << "Battery failed" << endl;
        LifecycleOperation::StringMap params;
        NodeCrashOperation *operation = new NodeCrashOperation();
        operation->initialize(networkNode, params);
        lifecycleController->initiateOperation(operation);
    }
}

virtual C inet::power::SimpleCcBattery::getNominalChargeCapacity ( ) const

inlineoverridevirtual

Returns the nominal charge capacity in the range [0, +infinity).

It specifies the maximum amount of charge that the energy storage can contain.

Implements inet::power::ICcEnergyStorage.

{ return nominalCapacity; }

virtual V inet::power::SimpleCcBattery::getNominalVoltage ( ) const

inlineoverridevirtual

Returns the open circuit voltage in the range [0, +infinity).

Implements inet::power::ICcEnergySource.

{ return nominalVoltage; }

virtual V inet::power::SimpleCcBattery::getOutputVoltage ( ) const

inlineoverridevirtual

Returns the output voltage in the ragne [0, +infinity).

Implements inet::power::ICcEnergySource.

{ return nominalVoltage + (totalCurrentGeneration - totalCurrentConsumption) * internalResistance; }

virtual C inet::power::SimpleCcBattery::getResidualChargeCapacity ( ) const

inlineoverridevirtual

Returns the residual charge capacity in the range [0, nominalCapacity].

It specifies the amount of charge that the energy storage contains at the moment.

Implements inet::power::ICcEnergyStorage.

{ return residualCapacity; }

virtual A inet::power::SimpleCcBattery::getTotalCurrentConsumption ( ) const

inlineoverridevirtual

Returns the total current consumption in the range [0, +infinity).

Reimplemented from inet::power::CcEnergySourceBase.

{ return totalCurrentConsumption; }

virtual A inet::power::SimpleCcBattery::getTotalCurrentGeneration ( ) const

inlineoverridevirtual

Returns the total current generation in the range [0, +infinity).

Reimplemented from inet::power::CcEnergySinkBase.

{ return totalCurrentGeneration; }

void inet::power::SimpleCcBattery::initialize ( int  stage )

overrideprotectedvirtual

{
    CcEnergyStorageBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        nominalCapacity = C(par("nominalCapacity"));
        nominalVoltage = V(par("nominalVoltage"));
        internalResistance = Ohm(par("internalResistance"));
        networkNode = findContainingNode(this);
        if (networkNode != nullptr) {
            nodeStatus = dynamic_cast<NodeStatus *>(networkNode->getSubmodule("status"));
            if (!nodeStatus)
                throw cRuntimeError("Cannot find node status");
            lifecycleController = dynamic_cast<LifecycleController *>(getModuleByPath("lifecycleController"));
            if (!lifecycleController)
                throw cRuntimeError("Cannot find lifecycle controller");
        }
        setResidualCapacity(C(par("initialCapacity")));
        WATCH(residualCapacity);
    }
}

void inet::power::SimpleCcBattery::setResidualCapacity ( C  newResidualCapacity )

protectedvirtual

Referenced by initialize(), and updateResidualCapacity().

{
    residualCapacity = newResidualCapacity;
    lastResidualCapacityUpdate = simTime();
    if (residualCapacity == C(0))
        EV_WARN << "Battery depleted" << endl;
    else if (residualCapacity == nominalCapacity)
        EV_INFO << "Battery charged" << endl;
    if (networkNode != nullptr)
        executeNodeOperation(newResidualCapacity);
    emit(residualChargeCapacityChangedSignal, residualCapacity.get());
}

void inet::power::SimpleCcBattery::updateResidualCapacity ( )

protectedvirtual

Referenced by updateTotalCurrentConsumption(), and updateTotalCurrentGeneration().

{
    simtime_t currentTime = simTime();
    if (currentTime != lastResidualCapacityUpdate) {
        C newResidualCapacity = residualCapacity + s((currentTime - lastResidualCapacityUpdate).dbl()) * (totalCurrentGeneration - totalCurrentConsumption);
        if (newResidualCapacity < C(0))
            newResidualCapacity = C(0);
        else if (newResidualCapacity > nominalCapacity)
            newResidualCapacity = nominalCapacity;
        setResidualCapacity(newResidualCapacity);
    }
}

void inet::power::SimpleCcBattery::updateTotalCurrentConsumption ( )

overrideprotectedvirtual

Reimplemented from inet::power::CcEnergyStorageBase.

{
    updateResidualCapacity();
    CcEnergyStorageBase::updateTotalCurrentConsumption();
}

void inet::power::SimpleCcBattery::updateTotalCurrentGeneration ( )

overrideprotectedvirtual

Reimplemented from inet::power::CcEnergyStorageBase.

{
    updateResidualCapacity();
    CcEnergyStorageBase::updateTotalCurrentGeneration();
}

Member Data Documentation

Ohm inet::power::SimpleCcBattery::internalResistance = Ohm(NaN)

protected

Referenced by initialize().

simtime_t inet::power::SimpleCcBattery::lastResidualCapacityUpdate = -1

protected

Referenced by setResidualCapacity(), and updateResidualCapacity().

LifecycleController* inet::power::SimpleCcBattery::lifecycleController = nullptr

protected

Referenced by executeNodeOperation(), and initialize().

cModule* inet::power::SimpleCcBattery::networkNode = nullptr

protected

Referenced by executeNodeOperation(), initialize(), and setResidualCapacity().

NodeStatus* inet::power::SimpleCcBattery::nodeStatus = nullptr

protected

Referenced by executeNodeOperation(), and initialize().

C inet::power::SimpleCcBattery::nominalCapacity = C(NaN)

protected

Referenced by initialize(), setResidualCapacity(), and updateResidualCapacity().

V inet::power::SimpleCcBattery::nominalVoltage = V(NaN)

protected

Referenced by initialize().

C inet::power::SimpleCcBattery::residualCapacity = C(NaN)

protected

Referenced by initialize(), setResidualCapacity(), and updateResidualCapacity().

---

The documentation for this class was generated from the following files:

• SimpleCcBattery.h
• SimpleCcBattery.cc