Index: examples/wireless/wifi-clear-channel-cmu.cc |
=================================================================== |
--- a/examples/wireless/wifi-clear-channel-cmu.cc |
+++ b/examples/wireless/wifi-clear-channel-cmu.cc |
@@ -32,19 +32,57 @@ |
{ |
public: |
Experiment (); |
+ /** |
+ * Constructor |
+ * \param name the test name |
+ */ |
Experiment (std::string name); |
+ /** |
+ * Run experiment |
+ * \param wifi the wifi helper |
+ * \param wifiPhy the wifi phy layer |
+ * \param wifiMac the wifi MAC |
+ * \param wifiChannel the wifi channel |
+ * \returns the total number of packets |
+ */ |
uint32_t Run (const WifiHelper &wifi, const YansWifiPhyHelper &wifiPhy, |
const WifiMacHelper &wifiMac, const YansWifiChannelHelper &wifiChannel); |
private: |
+ /** |
+ * Receive packet function |
+ * \param socket the socket to receive on |
+ */ |
void ReceivePacket (Ptr<Socket> socket); |
+ /** |
+ * Set position function |
+ * \param node the node |
+ * \param position the postion vector |
+ */ |
void SetPosition (Ptr<Node> node, Vector position); |
+ /** |
+ * Get position function |
+ * \param node the node |
+ * \returns the position vector |
+ */ |
Vector GetPosition (Ptr<Node> node); |
+ /** |
+ * Setup receive packetfunction |
+ * \param node the node |
+ * \returns the scoket to receive on |
+ */ |
Ptr<Socket> SetupPacketReceive (Ptr<Node> node); |
+ /** |
+ * Generate traffic function |
+ * \param socket the socket use |
+ * \param pktSize the packet size |
+ * \param pktCount the packet count |
+ * \param pktInterval the packet interval |
+ */ |
void GenerateTraffic (Ptr<Socket> socket, uint32_t pktSize, |
uint32_t pktCount, Time pktInterval ); |
- uint32_t m_pktsTotal; |
- Gnuplot2dDataset m_output; |
+ uint32_t m_pktsTotal; ///< total bytes received |
+ Gnuplot2dDataset m_output; ///< output data set |
}; |
Experiment::Experiment () |