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

TODO. More...

#include <ICcEnergySource.h>

Inheritance diagram for inet::power::ICcEnergySource:
inet::power::IEnergySource inet::power::CcEnergySourceBase inet::power::ICcEnergyStorage inet::power::CcEnergyStorageBase inet::power::CcEnergyStorageBase inet::power::SimpleCcBattery inet::power::SimpleCcBattery

Public Member Functions

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...
 
virtual A getTotalCurrentConsumption () const =0
 Returns the total current consumption in the range [0, +infinity). More...
 
- Public Member Functions inherited from inet::power::IEnergySource
virtual ~IEnergySource ()
 
virtual int getNumEnergyConsumers () const =0
 Returns the number of energy consumers in the range [0, +infinity). More...
 
virtual const IEnergyConsumergetEnergyConsumer (int index) const =0
 Returns the energy consumer for the provided index. More...
 
virtual void addEnergyConsumer (const IEnergyConsumer *energyConsumer)=0
 Adds a new energy consumer to the energy source. More...
 
virtual void removeEnergyConsumer (const IEnergyConsumer *energyConsumer)=0
 Removes a previously added energy consumer from this energy source. More...
 

Static Public Attributes

static simsignal_t currentConsumptionChangedSignal = cComponent::registerSignal("currentConsumptionChanged")
 The signal that is used to publish current consumption changes. More...
 

Detailed Description

TODO.

See the corresponding NED file for more details.

Author
Levente Meszaros

Member Function Documentation

virtual V inet::power::ICcEnergySource::getNominalVoltage ( ) const
pure virtual

Returns the open circuit voltage in the range [0, +infinity).

Implemented in inet::power::SimpleCcBattery.

virtual V inet::power::ICcEnergySource::getOutputVoltage ( ) const
pure virtual

Returns the output voltage in the ragne [0, +infinity).

Implemented in inet::power::SimpleCcBattery.

Referenced by inet::physicallayer::StateBasedCcEnergyConsumer::receiveSignal().

virtual A inet::power::ICcEnergySource::getTotalCurrentConsumption ( ) const
pure virtual

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

Implemented in inet::power::SimpleCcBattery, and inet::power::CcEnergySourceBase.

Member Data Documentation

simsignal_t inet::power::ICcEnergySource::currentConsumptionChangedSignal = cComponent::registerSignal("currentConsumptionChanged")
static

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