inet::power::EnergySourceBase Class Reference

#include <EnergySourceBase.h>

Inheritance diagram for inet::power::EnergySourceBase:

Public Member Functions
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...
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::IEnergySource
virtual	~IEnergySource ()

Protected Attributes
std::vector< const IEnergyConsumer * >	energyConsumers

Member Function Documentation

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

overridevirtual

Adds a new energy consumer to the energy source.

The energyConsumer parameter must not be nullptr.

Implements inet::power::IEnergySource.

Reimplemented in inet::power::CcEnergySourceBase, inet::power::EpEnergySourceBase, inet::power::CcEnergyStorageBase, and inet::power::EpEnergyStorageBase.

Referenced by inet::power::CcEnergySourceBase::addEnergyConsumer(), and inet::power::EpEnergySourceBase::addEnergyConsumer().

{
    energyConsumers.push_back(energyConsumer);
}

const IEnergyConsumer * inet::power::EnergySourceBase::getEnergyConsumer ( int  index ) const

overridevirtual

Returns the energy consumer for the provided index.

This functions throws an exception if the index is out of range, and it never returns nullptr.

Implements inet::power::IEnergySource.

{
    return energyConsumers[index];
}

virtual int inet::power::EnergySourceBase::getNumEnergyConsumers ( ) const

inlineoverridevirtual

Returns the number of energy consumers in the range [0, +infinity).

Implements inet::power::IEnergySource.

{ return energyConsumers.size(); }

void inet::power::EnergySourceBase::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.

Implements inet::power::IEnergySource.

Reimplemented in inet::power::CcEnergySourceBase, inet::power::EpEnergySourceBase, inet::power::CcEnergyStorageBase, and inet::power::EpEnergyStorageBase.

Referenced by inet::power::CcEnergySourceBase::removeEnergyConsumer(), and inet::power::EpEnergySourceBase::removeEnergyConsumer().

{
    auto it = std::find(energyConsumers.begin(), energyConsumers.end(), energyConsumer);
    if (it == energyConsumers.end())
        throw cRuntimeError("Energy consumer not found");
    else
        energyConsumers.erase(it);
}

Member Data Documentation

std::vector<const IEnergyConsumer *> inet::power::EnergySourceBase::energyConsumers

protected

Referenced by addEnergyConsumer(), inet::power::CcEnergySourceBase::computeTotalCurrentConsumption(), inet::power::EpEnergySourceBase::computeTotalPowerConsumption(), getEnergyConsumer(), and removeEnergyConsumer().

---

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

• EnergySourceBase.h
• EnergySourceBase.cc