inet::power::EpEnergySinkBase Class Reference

#include <EpEnergySinkBase.h>

Inheritance diagram for inet::power::EpEnergySinkBase:

Public Member Functions
virtual W	getTotalPowerGeneration () const override
	Returns the total power generation in the range [0, +infinity). 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...
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 W	computeTotalPowerGeneration () const
virtual void	updateTotalPowerGeneration ()

Protected Attributes
W	totalPowerGeneration = W(NaN)
Protected Attributes inherited from inet::power::EnergySinkBase
std::vector< const IEnergyGenerator * >	energyGenerators

Additional Inherited Members
Static Public Attributes inherited from inet::power::IEpEnergySink
static simsignal_t	powerGenerationChangedSignal = cComponent::registerSignal("powerGenerationChanged")
	The signal that is used to publish power generation changes. More...

Member Function Documentation

void inet::power::EpEnergySinkBase::addEnergyGenerator ( const IEnergyGenerator *  energyGenerator )

overridevirtual

Adds a new energy generator to the energy sink.

The energyGenerator parameter must not be nullptr.

Reimplemented from inet::power::EnergySinkBase.

Reimplemented in inet::power::EpEnergyStorageBase.

Referenced by inet::power::EpEnergyStorageBase::addEnergyGenerator().

{
    EnergySinkBase::addEnergyGenerator(energyGenerator);
    auto module = const_cast<cModule *>(check_and_cast<const cModule *>(energyGenerator));
    module->subscribe(IEpEnergyGenerator::powerGenerationChangedSignal, this);
    updateTotalPowerGeneration();
}

W inet::power::EpEnergySinkBase::computeTotalPowerGeneration ( ) const

protectedvirtual

Referenced by inet::power::EpEnergyStorageBase::initialize(), and updateTotalPowerGeneration().

{
    W totalPowerGeneration = W(0);
    for (auto energyGenerator : energyGenerators)
        totalPowerGeneration += check_and_cast<const IEpEnergyGenerator *>(energyGenerator)->getPowerGeneration();
    return totalPowerGeneration;
}

virtual W inet::power::EpEnergySinkBase::getTotalPowerGeneration ( ) const

inlineoverridevirtual

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

Implements inet::power::IEpEnergySink.

{ return totalPowerGeneration; }

void inet::power::EpEnergySinkBase::removeEnergyGenerator ( const IEnergyGenerator *  energyGenerator )

overridevirtual

Removes a previously added energy generator from this energy sink.

This functions throws an exception if the generator is not found.

Reimplemented from inet::power::EnergySinkBase.

Reimplemented in inet::power::EpEnergyStorageBase.

Referenced by inet::power::EpEnergyStorageBase::removeEnergyGenerator().

{
    EnergySinkBase::removeEnergyGenerator(energyGenerator);
    auto module = const_cast<cModule *>(check_and_cast<const cModule *>(energyGenerator));
    module->unsubscribe(IEpEnergyGenerator::powerGenerationChangedSignal, this);
    updateTotalPowerGeneration();
}

void inet::power::EpEnergySinkBase::updateTotalPowerGeneration ( )

protectedvirtual

Reimplemented in inet::power::SimpleEpEnergyStorage, inet::power::IdealEpEnergyStorage, and inet::power::EpEnergyStorageBase.

Referenced by addEnergyGenerator(), removeEnergyGenerator(), and inet::power::EpEnergyStorageBase::updateTotalPowerGeneration().

{
    totalPowerGeneration = computeTotalPowerGeneration();
}

Member Data Documentation

W inet::power::EpEnergySinkBase::totalPowerGeneration = W(NaN)

protected

Referenced by computeTotalPowerGeneration(), inet::power::EpEnergyStorageBase::initialize(), inet::power::SimpleEpEnergyStorage::scheduleTimer(), inet::power::IdealEpEnergyStorage::updateEnergyBalance(), inet::power::SimpleEpEnergyStorage::updateResidualCapacity(), inet::power::EpEnergyStorageBase::updateTotalPowerGeneration(), and updateTotalPowerGeneration().

---

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

• EpEnergySinkBase.h
• EpEnergySinkBase.cc