Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(3388)

Unified Diff: src/energy/model/basic-energy-harvester.h

Issue 318390043: FInal updates to correct doxygen warnings for the energy module (Closed)
Patch Set: Update with check-style.py changes Created 7 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/energy/helper/rv-battery-model-helper.h ('k') | src/energy/model/basic-energy-harvester.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/energy/model/basic-energy-harvester.h
===================================================================
--- a/src/energy/model/basic-energy-harvester.h
+++ b/src/energy/model/basic-energy-harvester.h
@@ -45,9 +45,13 @@
* energy as (time in seconds * power in Watt).
*
*/
-class BasicEnergyHarvester: public EnergyHarvester
+class BasicEnergyHarvester : public EnergyHarvester
{
public:
+ /**
+ * \brief Get the type ID.
+ * \return the object TypeId
+ */
static TypeId GetTypeId (void);
BasicEnergyHarvester ();
@@ -114,15 +118,14 @@
void UpdateHarvestedPower (void);
private:
+ Ptr<RandomVariableStream> m_harvestablePower; ///< Random variable for the harvestable power
- Ptr<RandomVariableStream> m_harvestablePower; // Random variable for the harvestable power
+ TracedValue<double> m_harvestedPower; ///< current harvested power, in Watt
+ TracedValue<double> m_totalEnergyHarvestedJ; ///< total harvested energy, in Joule
- TracedValue<double> m_harvestedPower; // current harvested power, in Watt
- TracedValue<double> m_totalEnergyHarvestedJ; // total harvested energy, in Joule
-
- EventId m_energyHarvestingUpdateEvent; // energy harvesting event
- Time m_lastHarvestingUpdateTime; // last harvesting time
- Time m_harvestedPowerUpdateInterval; // harvestable energy update interval
+ EventId m_energyHarvestingUpdateEvent; ///< energy harvesting event
+ Time m_lastHarvestingUpdateTime; ///< last harvesting time
+ Time m_harvestedPowerUpdateInterval; ///< harvestable energy update interval
};
« no previous file with comments | « src/energy/helper/rv-battery-model-helper.h ('k') | src/energy/model/basic-energy-harvester.cc » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b