INET Framework for OMNeT++/OMNEST
inet::power::IEnergyConsumer Class Referenceabstract

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

#include <IEnergyConsumer.h>

Inheritance diagram for inet::power::IEnergyConsumer:
inet::power::ICcEnergyConsumer inet::power::IEpEnergyConsumer inet::physicallayer::StateBasedCcEnergyConsumer inet::physicallayer::StateBasedEpEnergyConsumer inet::power::AlternatingEpEnergyConsumer

Public Member Functions

virtual ~IEnergyConsumer ()
 
virtual IEnergySourcegetEnergySource () const =0
 Returns the energy source that provides energy for this energy consumer. More...
 

Detailed Description

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

This interface is extended by various energy consumer interfaces. Actual energy consumer 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::IEnergyConsumer::~IEnergyConsumer ( )
inlinevirtual
42 {}

Member Function Documentation

virtual IEnergySource* inet::power::IEnergyConsumer::getEnergySource ( ) const
pure virtual

Returns the energy source that provides energy for this energy consumer.

This function never returns nullptr.

Implemented in inet::physicallayer::StateBasedCcEnergyConsumer, inet::physicallayer::StateBasedEpEnergyConsumer, and inet::power::AlternatingEpEnergyConsumer.


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