inet::power::IEnergyGenerator Class Reference

This class is a base interface that must be implemented by energy generator models to integrate with other parts of the power model. More...

#include <IEnergyGenerator.h>

Inheritance diagram for inet::power::IEnergyGenerator:

Public Member Functions
virtual	~IEnergyGenerator ()
virtual IEnergySink *	getEnergySink () const =0
	Returns the energy sink that absorbs energy from this energy generator. More...

Detailed Description

This class is a base interface that must be implemented by energy generator models to integrate with other parts of the power model.

Energy generators connect to an energy sink that absorbs the generated energy. Energy generators are required to notify their energy sink when their energy generation changes. This interface is extended by various energy generator interfaces. Actual energy generator implementations should implement one of the derived interfaces.

See the corresponding NED file for more details.

Author

Levente Meszaros

Constructor & Destructor Documentation

virtual inet::power::IEnergyGenerator::~IEnergyGenerator ( )

inlinevirtual

{}

Member Function Documentation

virtual IEnergySink* inet::power::IEnergyGenerator::getEnergySink ( ) const

pure virtual

Returns the energy sink that absorbs energy from this energy generator.

This function never returns nullptr.

Implemented in inet::power::AlternatingEpEnergyGenerator.

---

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

• IEnergyGenerator.h