inet::power::CcEnergySourceBase Class Reference

#include <CcEnergySourceBase.h>

Inheritance diagram for inet::power::CcEnergySourceBase:

Public Member Functions
virtual A	getTotalCurrentConsumption () const override
	Returns the total current consumption in the range [0, +infinity). More...
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...
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::ICcEnergySource
virtual V	getNominalVoltage () const =0
	Returns the open circuit voltage in the range [0, +infinity). More...
virtual V	getOutputVoltage () const =0
	Returns the output voltage in the ragne [0, +infinity). More...

Protected Member Functions
virtual A	computeTotalCurrentConsumption () const
virtual void	updateTotalCurrentConsumption ()

Protected Attributes
A	totalCurrentConsumption = A(NaN)
Protected Attributes inherited from inet::power::EnergySourceBase
std::vector< const IEnergyConsumer * >	energyConsumers

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...

Member Function Documentation

void inet::power::CcEnergySourceBase::addEnergyConsumer ( const IEnergyConsumer *  energyConsumer )

overridevirtual

Adds a new energy consumer to the energy source.

The energyConsumer parameter must not be nullptr.

Reimplemented from inet::power::EnergySourceBase.

Reimplemented in inet::power::CcEnergyStorageBase.

Referenced by inet::power::CcEnergyStorageBase::addEnergyConsumer().

{
    EnergySourceBase::addEnergyConsumer(energyConsumer);
    auto module = const_cast<cModule *>(check_and_cast<const cModule *>(energyConsumer));
    module->subscribe(ICcEnergyConsumer::currentConsumptionChangedSignal, this);
    updateTotalCurrentConsumption();
}

A inet::power::CcEnergySourceBase::computeTotalCurrentConsumption ( ) const

protectedvirtual

Referenced by inet::power::CcEnergyStorageBase::initialize(), and updateTotalCurrentConsumption().

{
    A totalCurrentConsumption = A(0);
    for (auto energyConsumer : energyConsumers)
        totalCurrentConsumption += check_and_cast<const ICcEnergyConsumer *>(energyConsumer)->getCurrentConsumption();
    return totalCurrentConsumption;
}

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

inlineoverridevirtual

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

Implements inet::power::ICcEnergySource.

Reimplemented in inet::power::SimpleCcBattery.

{ return totalCurrentConsumption; }

void inet::power::CcEnergySourceBase::removeEnergyConsumer ( const IEnergyConsumer *  energyConsumer )

overridevirtual

Removes a previously added energy consumer from this energy source.

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

Reimplemented from inet::power::EnergySourceBase.

Reimplemented in inet::power::CcEnergyStorageBase.

Referenced by inet::power::CcEnergyStorageBase::removeEnergyConsumer().

{
    EnergySourceBase::removeEnergyConsumer(energyConsumer);
    auto module = const_cast<cModule *>(check_and_cast<const cModule *>(energyConsumer));
    module->unsubscribe(ICcEnergyConsumer::currentConsumptionChangedSignal, this);
    updateTotalCurrentConsumption();
}

void inet::power::CcEnergySourceBase::updateTotalCurrentConsumption ( )

protectedvirtual

Reimplemented in inet::power::SimpleCcBattery, and inet::power::CcEnergyStorageBase.

Referenced by addEnergyConsumer(), removeEnergyConsumer(), and inet::power::CcEnergyStorageBase::updateTotalCurrentConsumption().

{
    totalCurrentConsumption = computeTotalCurrentConsumption();
}

Member Data Documentation

A inet::power::CcEnergySourceBase::totalCurrentConsumption = A(NaN)

protected

Referenced by computeTotalCurrentConsumption(), inet::power::CcEnergyStorageBase::initialize(), inet::power::SimpleCcBattery::updateResidualCapacity(), inet::power::CcEnergyStorageBase::updateTotalCurrentConsumption(), and updateTotalCurrentConsumption().

---

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

• CcEnergySourceBase.h
• CcEnergySourceBase.cc