inet::power::ICcEnergyStorage Class Referenceabstract
TODO. More...
#include <ICcEnergyStorage.h>
Inheritance diagram for inet::power::ICcEnergyStorage:
Public Member Functions | |
| virtual C | getNominalChargeCapacity () const =0 |
| Returns the nominal charge capacity in the range [0, +infinity). More... | |
| virtual C | getResidualChargeCapacity () const =0 |
| Returns the residual charge capacity in the range [0, nominalCapacity]. More... | |
 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... | |
| 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 IEnergyConsumer * | getEnergyConsumer (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... | |
| Public Member Functions inherited from inet::power::ICcEnergySink | |
| virtual A | getTotalCurrentGeneration () const =0 |
| Returns the total current generation in the range [0, +infinity). More... | |
| Public Member Functions inherited from inet::power::IEnergySink | |
| virtual | ~IEnergySink () |
| virtual int | getNumEnergyGenerators () const =0 |
| Returns the number of energy generators in the range [0, +infinity). More... | |
| virtual const IEnergyGenerator * | getEnergyGenerator (int index) const =0 |
| Returns the energy generator for the provided index. More... | |
| virtual void | addEnergyGenerator (const IEnergyGenerator *energyGenerator)=0 |
| Adds a new energy generator to the energy sink. More... | |
| virtual void | removeEnergyGenerator (const IEnergyGenerator *energyGenerator)=0 |
| Removes a previously added energy generator from this energy sink. More... | |
Static Public Attributes | |
| static simsignal_t | residualChargeCapacityChangedSignal = cComponent::registerSignal("residualChargeCapacityChanged") |
| The signal that is used to publish residual charge capacity changes also including when the energy storage becomes completely depleted or charged. More... | |
| 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... | |
| Static Public Attributes inherited from inet::power::ICcEnergySink | |
| static simsignal_t | currentGenerationChangedSignal = cComponent::registerSignal("currentGenerationChanged") |
| The signal that is used to publish current generation changes. More... | |
Detailed Description
TODO.
See the corresponding NED file for more details.
Member Function Documentation
◆ getNominalChargeCapacity()
|
pure virtual |
Returns the nominal charge capacity in the range [0, +infinity).
It specifies the maximum amount of charge that the energy storage can contain.
Implemented in inet::power::SimpleCcBattery.
◆ getResidualChargeCapacity()
|
pure virtual |
Returns the residual charge capacity in the range [0, nominalCapacity].
It specifies the amount of charge that the energy storage contains at the moment.
Implemented in inet::power::SimpleCcBattery.
Member Data Documentation
◆ residualChargeCapacityChangedSignal
|
static |
The signal that is used to publish residual charge capacity changes also including when the energy storage becomes completely depleted or charged.
Referenced by inet::power::SimpleCcBattery::setResidualCapacity().
The documentation for this class was generated from the following files:
