Index: src/energy/model/basic-energy-source.h |
=================================================================== |
--- a/src/energy/model/basic-energy-source.h |
+++ b/src/energy/model/basic-energy-source.h |
@@ -37,6 +37,10 @@ |
class BasicEnergySource : public EnergySource |
{ |
public: |
+ /** |
+ * \brief Get the type ID. |
+ * \return the object TypeId |
+ */ |
static TypeId GetTypeId (void); |
BasicEnergySource (); |
virtual ~BasicEnergySource (); |
@@ -136,16 +140,16 @@ |
void CalculateRemainingEnergy (void); |
private: |
- double m_initialEnergyJ; // initial energy, in Joules |
- double m_supplyVoltageV; // supply voltage, in Volts |
- double m_lowBatteryTh; // low battery threshold, as a fraction of the initial energy |
- double m_highBatteryTh; // high battery threshold, as a fraction of the initial energy |
- bool m_depleted; // set to true when the remaining energy goes below the low threshold, |
+ double m_initialEnergyJ; ///< initial energy, in Joules |
+ double m_supplyVoltageV; ///< supply voltage, in Volts |
+ double m_lowBatteryTh; ///< low battery threshold, as a fraction of the initial energy |
+ double m_highBatteryTh; ///< high battery threshold, as a fraction of the initial energy |
+ bool m_depleted; ///< set to true when the remaining energy goes below the low threshold, |
// set to false again when the remaining energy exceeds the high threshold |
- TracedValue<double> m_remainingEnergyJ; // remaining energy, in Joules |
- EventId m_energyUpdateEvent; // energy update event |
- Time m_lastUpdateTime; // last update time |
- Time m_energyUpdateInterval; // energy update interval |
+ TracedValue<double> m_remainingEnergyJ; ///< remaining energy, in Joules |
+ EventId m_energyUpdateEvent; ///< energy update event |
+ Time m_lastUpdateTime; ///< last update time |
+ Time m_energyUpdateInterval; ///< energy update interval |
}; |