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

Unified Diff: src/dsdv/examples/dsdv-manet.cc

Issue 320070043: Final updates to correct doxygen warnings for the dsdv module (Closed)
Patch Set: Additional doxygen corrections Created 6 years, 10 months 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 | « no previous file | src/dsdv/model/dsdv-packet.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/dsdv/examples/dsdv-manet.cc
===================================================================
--- a/src/dsdv/examples/dsdv-manet.cc
+++ b/src/dsdv/examples/dsdv-manet.cc
@@ -45,10 +45,31 @@
NS_LOG_COMPONENT_DEFINE ("DsdvManetExample");
+/**
+ * \ingroup dsdv
+ * \ingroup dsdv-examples
+ * \ingroup examples
+ *
+ * \brief DSDV Manet example
+ */
class DsdvManetExample
{
public:
DsdvManetExample ();
+ /**
+ * Run function
+ * \param nWifis The total number of nodes
+ * \param nSinks The total number of receivers
+ * \param totalTime The total simulation time
+ * \param rate The network speed
+ * \param phyMode The physical mode
+ * \param nodeSpeed The node speed
+ * \param periodicUpdateInterval The routing update iterval
+ * \param settlingTime The routing update settling time
+ * \param dataStart The data transmission start time
+ * \param printRoutes print the routes if true
+ * \param CSVfileName The CSV file name
+ */
void CaseRun (uint32_t nWifis,
uint32_t nSinks,
double totalTime,
@@ -62,32 +83,54 @@
std::string CSVfileName);
private:
- uint32_t m_nWifis;
- uint32_t m_nSinks;
- double m_totalTime;
- std::string m_rate;
- std::string m_phyMode;
- uint32_t m_nodeSpeed;
- uint32_t m_periodicUpdateInterval;
- uint32_t m_settlingTime;
- double m_dataStart;
- uint32_t bytesTotal;
- uint32_t packetsReceived;
- bool m_printRoutes;
- std::string m_CSVfileName;
+ uint32_t m_nWifis; ///< total number of nodes
+ uint32_t m_nSinks; ///< number of receiver nodes
+ double m_totalTime; ///< total simulationn time (in seconds)
+ std::string m_rate; ///< network bandwidth
+ std::string m_phyMode; ///< femote station manager data mode
+ uint32_t m_nodeSpeed; ///< mobility speed
+ uint32_t m_periodicUpdateInterval; ///< routing update interval
+ uint32_t m_settlingTime; ///< routing setting time
+ double m_dataStart; ///< time to start data transmissions (seconds)
+ uint32_t bytesTotal; ///< total bytes received by all nodes
+ uint32_t packetsReceived; ///< total packets received by all nodes
+ bool m_printRoutes; ///< print routing table
+ std::string m_CSVfileName; ///< CSV file name
- NodeContainer nodes;
- NetDeviceContainer devices;
- Ipv4InterfaceContainer interfaces;
+ NodeContainer nodes; ///< the collection of nodes
+ NetDeviceContainer devices; ///< the collection of devices
+ Ipv4InterfaceContainer interfaces; ///< the collection of interfaces
private:
+ /// Create and initialize all nodes
void CreateNodes ();
+ /**
+ * Create and initialize all devices
+ * \param tr_name The trace file name
+ */
void CreateDevices (std::string tr_name);
+ /**
+ * Create network
+ * \param tr_name The trace file name
+ */
void InstallInternetStack (std::string tr_name);
+ /// Create data sinks and sources
void InstallApplications ();
+ /// Setup mobility model
void SetupMobility ();
- void ReceivePacket (Ptr <Socket> );
- Ptr <Socket> SetupPacketReceive (Ipv4Address, Ptr <Node> );
+ /**
+ * Packet receive function
+ * \param socket The communication socket
+ */
+ void ReceivePacket (Ptr <Socket> socket);
+ /**
+ * Setup packet receivers
+ * \param addr the receiving IPv4 address
+ * \param node the receiving node
+ * \returns the communication socket
+ */
+ Ptr <Socket> SetupPacketReceive (Ipv4Address addr, Ptr <Node> node );
+ /// Check network throughput
void CheckThroughput ();
};
@@ -252,11 +295,11 @@
std::ostringstream speedConstantRandomVariableStream;
speedConstantRandomVariableStream << "ns3::ConstantRandomVariable[Constant="
- << m_nodeSpeed
- << "]";
+ << m_nodeSpeed
+ << "]";
Ptr <PositionAllocator> taPositionAlloc = pos.Create ()->GetObject <PositionAllocator> ();
- mobility.SetMobilityModel ("ns3::RandomWaypointMobilityModel", "Speed", StringValue (speedConstantRandomVariableStream.str ()),
+ mobility.SetMobilityModel ("ns3::RandomWaypointMobilityModel", "Speed", StringValue (speedConstantRandomVariableStream.str ()),
"Pause", StringValue ("ns3::ConstantRandomVariable[Constant=2.0]"), "PositionAllocator", PointerValue (taPositionAlloc));
mobility.SetPositionAllocator (taPositionAlloc);
mobility.Install (nodes);
« no previous file with comments | « no previous file | src/dsdv/model/dsdv-packet.h » ('j') | no next file with comments »

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