F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Replace Doxygen tags using \ with @

Browse Source
This commit is contained in:
Eduardo Almeida
2024-11-08 18:05:46 +00:00
parent e99d17039b
commit 6ef966c4cf
1800 changed files with 49640 additions and 49640 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
examples/wireless/mixed-wired-wireless.cc
View File

@@ -72,8 +72,8 @@ NS_LOG_COMPONENT_DEFINE("MixedWireless");
* This function will be used below as a trace sink, if the command-line
* argument or default value "useCourseChangeCallback" is set to true
*
* \param path The callback path.
* \param model The mobility model.
* @param path The callback path.
* @param model The mobility model.
*/
static void
CourseChangeCallback(std::string path, Ptr<const MobilityModel> model)

6
examples/wireless/wifi-80211e-txop.cc
View File

@@ -63,9 +63,9 @@ struct TxopDurationTracer
/**
* Callback connected to TXOP duration trace source.
*
* \param startTime TXOP start time
* \param duration TXOP duration
* \param linkId the ID of the link
* @param startTime TXOP start time
* @param duration TXOP duration
* @param linkId the ID of the link
*/
void Trace(Time startTime, Time duration, uint8_t linkId);
Time m_max; //!< maximum TXOP duration

28
examples/wireless/wifi-adhoc.cc
View File

@@ -36,17 +36,17 @@ class Experiment
Experiment();
/**
* Constructor.
* \param name The name of the experiment.
* @param name The name of the experiment.
*/
Experiment(std::string name);
/**
* Run an experiment.
* \param wifi //!< The WifiHelper class.
* \param wifiPhy //!< The YansWifiPhyHelper class.
* \param wifiMac //!< The WifiMacHelper class.
* \param wifiChannel //!< The YansWifiChannelHelper class.
* \return a 2D dataset of the experiment data.
* @param wifi //!< The WifiHelper class.
* @param wifiPhy //!< The YansWifiPhyHelper class.
* @param wifiMac //!< The WifiMacHelper class.
* @param wifiChannel //!< The YansWifiChannelHelper class.
* @return a 2D dataset of the experiment data.
*/
Gnuplot2dDataset Run(const WifiHelper& wifi,
const YansWifiPhyHelper& wifiPhy,
@@ -56,30 +56,30 @@ class Experiment
private:
/**
* Receive a packet.
* \param socket The receiving socket.
* @param socket The receiving socket.
*/
void ReceivePacket(Ptr<Socket> socket);
/**
* Set the position of a node.
* \param node The node.
* \param position The position of the node.
* @param node The node.
* @param position The position of the node.
*/
void SetPosition(Ptr<Node> node, Vector position);
/**
* Get the position of a node.
* \param node The node.
* \return the position of the node.
* @param node The node.
* @return the position of the node.
*/
Vector GetPosition(Ptr<Node> node);
/**
* Move a node by 1m on the x axis, stops at 210m.
* \param node The node.
* @param node The node.
*/
void AdvancePosition(Ptr<Node> node);
/**
* Setup the receiving socket.
* \param node The receiving node.
* \return the socket.
* @param node The receiving node.
* @return the socket.
*/
Ptr<Socket> SetupPacketReceive(Ptr<Node> node);

44
examples/wireless/wifi-ap.cc
View File

@@ -28,8 +28,8 @@ static bool g_verbose = true;
/**
* MAC-level TX trace.
*
* \param context The context.
* \param p The packet.
* @param context The context.
* @param p The packet.
*/
void
DevTxTrace(std::string context, Ptr<const Packet> p)
@@ -43,8 +43,8 @@ DevTxTrace(std::string context, Ptr<const Packet> p)
/**
* MAC-level RX trace.
*
* \param context The context.
* \param p The packet.
* @param context The context.
* @param p The packet.
*/
void
DevRxTrace(std::string context, Ptr<const Packet> p)
@@ -58,11 +58,11 @@ DevRxTrace(std::string context, Ptr<const Packet> p)
/**
* PHY-level RX OK trace
*
* \param context The context.
* \param packet The packet.
* \param snr The SNR.
* \param mode The wifi mode.
* \param preamble The preamble.
* @param context The context.
* @param packet The packet.
* @param snr The SNR.
* @param mode The wifi mode.
* @param preamble The preamble.
*/
void
PhyRxOkTrace(std::string context,
@@ -80,9 +80,9 @@ PhyRxOkTrace(std::string context,
/**
* PHY-level RX error trace
*
* \param context The context.
* \param packet The packet.
* \param snr The SNR.
* @param context The context.
* @param packet The packet.
* @param snr The SNR.
*/
void
PhyRxErrorTrace(std::string context, Ptr<const Packet> packet, double snr)
@@ -96,11 +96,11 @@ PhyRxErrorTrace(std::string context, Ptr<const Packet> packet, double snr)
/**
* PHY-level TX trace.
*
* \param context The context.
* \param packet The packet.
* \param mode The wifi mode.
* \param preamble The preamble.
* \param txPower The TX power.
* @param context The context.
* @param packet The packet.
* @param mode The wifi mode.
* @param preamble The preamble.
* @param txPower The TX power.
*/
void
PhyTxTrace(std::string context,
@@ -118,10 +118,10 @@ PhyTxTrace(std::string context,
/**
* PHY state trace.
*
* \param context The context.
* \param start Start time of the state.
* \param duration Duration of the state.
* \param state The state.
* @param context The context.
* @param start Start time of the state.
* @param duration Duration of the state.
* @param state The state.
*/
void
PhyStateTrace(std::string context, Time start, Time duration, WifiPhyState state)
@@ -136,7 +136,7 @@ PhyStateTrace(std::string context, Time start, Time duration, WifiPhyState state
/**
* Move a node position by 5m on the x axis every second, up to 210m.
*
* \param node The node.
* @param node The node.
*/
static void
AdvancePosition(Ptr<Node> node)

4
examples/wireless/wifi-backward-compatibility.cc
View File

@@ -44,8 +44,8 @@ NS_LOG_COMPONENT_DEFINE("wifi-backward-compatibility");
/**
* Convert a string (e.g., "80211a") to a pair {WifiStandard, WifiPhyBand}
*
* \param version The WiFi standard version.
* \return a pair of WifiStandard, WifiPhyBand
* @param version The WiFi standard version.
* @return a pair of WifiStandard, WifiPhyBand
*/
std::pair<WifiStandard, WifiPhyBand>
ConvertStringToStandardAndBand(std::string version)

34
examples/wireless/wifi-clear-channel-cmu.cc
View File

@@ -34,16 +34,16 @@ class Experiment
Experiment();
/**
* Constructor.
* \param name The name of the experiment.
* @param name The name of the experiment.
*/
Experiment(std::string name);
/**
* Run an experiment.
* \param wifi //!< The WifiHelper class.
* \param wifiPhy //!< The YansWifiPhyHelper class.
* \param wifiMac //!< The WifiMacHelper class.
* \param wifiChannel //!< The YansWifiChannelHelper class.
* \return the number of received packets.
* @param wifi //!< The WifiHelper class.
* @param wifiPhy //!< The YansWifiPhyHelper class.
* @param wifiMac //!< The WifiMacHelper class.
* @param wifiChannel //!< The YansWifiChannelHelper class.
* @return the number of received packets.
*/
uint32_t Run(const WifiHelper& wifi,
const YansWifiPhyHelper& wifiPhy,
@@ -53,33 +53,33 @@ class Experiment
private:
/**
* Receive a packet.
* \param socket The receiving socket.
* @param socket The receiving socket.
*/
void ReceivePacket(Ptr<Socket> socket);
/**
* Set the position of a node.
* \param node The node.
* \param position The position of the node.
* @param node The node.
* @param position The position of the node.
*/
void SetPosition(Ptr<Node> node, Vector position);
/**
* Get the position of a node.
* \param node The node.
* \return the position of the node.
* @param node The node.
* @return the position of the node.
*/
Vector GetPosition(Ptr<Node> node);
/**
* Setup the receiving socket.
* \param node The receiving node.
* \return the socket.
* @param node The receiving node.
* @return the socket.
*/
Ptr<Socket> SetupPacketReceive(Ptr<Node> node);
/**
* Generate the traffic.
* \param socket The sending socket.
* \param pktSize The packet size.
* \param pktCount The number of packets to send.
* \param pktInterval The time between packets.
* @param socket The sending socket.
* @param pktSize The packet size.
* @param pktCount The number of packets to send.
* @param pktInterval The time between packets.
*/
void GenerateTraffic(Ptr<Socket> socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval);

20
examples/wireless/wifi-eht-network.cc
View File

@@ -59,10 +59,10 @@ using namespace ns3;
NS_LOG_COMPONENT_DEFINE("eht-wifi-network");
/**
* \param udp true if UDP is used, false if TCP is used
* \param serverApp a container of server applications
* \param payloadSize the size in bytes of the packets
* \return the bytes received by each server application
* @param udp true if UDP is used, false if TCP is used
* @param serverApp a container of server applications
* @param payloadSize the size in bytes of the packets
* @return the bytes received by each server application
*/
std::vector<uint64_t>
GetRxBytes(bool udp, const ApplicationContainer& serverApp, uint32_t payloadSize)
@@ -87,12 +87,12 @@ GetRxBytes(bool udp, const ApplicationContainer& serverApp, uint32_t payloadSize
/**
* Print average throughput over an intermediate time interval.
* \param rxBytes a vector of the amount of bytes received by each server application
* \param udp true if UDP is used, false if TCP is used
* \param serverApp a container of server applications
* \param payloadSize the size in bytes of the packets
* \param tputInterval the duration of an intermediate time interval
* \param simulationTime the simulation time in seconds
* @param rxBytes a vector of the amount of bytes received by each server application
* @param udp true if UDP is used, false if TCP is used
* @param serverApp a container of server applications
* @param payloadSize the size in bytes of the packets
* @param tputInterval the duration of an intermediate time interval
* @param simulationTime the simulation time in seconds
*/
void
PrintIntermediateTput(std::vector<uint64_t>& rxBytes,

8
examples/wireless/wifi-hidden-terminal.cc
View File

@@ -38,8 +38,8 @@ using namespace ns3;
/**
* Run single 10 seconds experiment
*
* \param enableCtsRts if true, enable RTS/CTS for packets larger than 100 bytes.
* \param wifiManager WiFi manager to use.
* @param enableCtsRts if true, enable RTS/CTS for packets larger than 100 bytes.
* @param wifiManager WiFi manager to use.
*/
void
experiment(bool enableCtsRts, std::string wifiManager)
@@ -115,7 +115,7 @@ experiment(bool enableCtsRts, std::string wifiManager)
// flow 2: node 2 -> node 1
/**
* \internal
* @internal
* The slightly different start times and data rates are a workaround
* for \bugid{388} and \bugid{912}
*/
@@ -124,7 +124,7 @@ experiment(bool enableCtsRts, std::string wifiManager)
cbrApps.Add(onOffHelper.Install(nodes.Get(2)));
/**
* \internal
* @internal
* We also use separate UDP applications that will send a single
* packet before the CBR flows start.
* This is a workaround for the lack of perfect ARP, see \bugid{187}

4
examples/wireless/wifi-mixed-network.cc
View File

@@ -79,8 +79,8 @@ class Experiment
Experiment();
/**
* Run an experiment with the given parameters
* \param params the given parameters
* \return the throughput
* @param params the given parameters
* @return the throughput
*/
double Run(Parameters params);
};

90
examples/wireless/wifi-multirate.cc
View File

@@ -69,19 +69,19 @@ class Experiment
public:
Experiment();
/**
* \brief Construct a new Experiment object
* @brief Construct a new Experiment object
*
* \param name The name of the experiment.
* @param name The name of the experiment.
*/
Experiment(std::string name);
/**
* Run an experiment.
* \param wifi The WifiHelper class.
* \param wifiPhy The YansWifiPhyHelper class.
* \param wifiMac The WifiMacHelper class.
* \param wifiChannel The YansWifiChannelHelper class.
* \param mobility The MobilityHelper class.
* \return a 2D dataset of the experiment data.
* @param wifi The WifiHelper class.
* @param wifiPhy The YansWifiPhyHelper class.
* @param wifiMac The WifiMacHelper class.
* @param wifiChannel The YansWifiChannelHelper class.
* @param mobility The MobilityHelper class.
* @return a 2D dataset of the experiment data.
*/
Gnuplot2dDataset Run(const WifiHelper& wifi,
const YansWifiPhyHelper& wifiPhy,
@@ -90,18 +90,18 @@ class Experiment
const MobilityHelper& mobility);
/**
* \brief Setup the experiment from the command line arguments.
* @brief Setup the experiment from the command line arguments.
*
* \param argc The argument count.
* \param argv The argument vector.
* \return true
* @param argc The argument count.
* @param argv The argument vector.
* @return true
*/
bool CommandSetup(int argc, char** argv);
/**
* \brief Check if routing is enabled.
* @brief Check if routing is enabled.
*
* \return true if routing is enabled.
* @return true if routing is enabled.
*/
bool IsRouting() const
{
@@ -109,9 +109,9 @@ class Experiment
}
/**
* \brief Check if mobility is enabled.
* @brief Check if mobility is enabled.
*
* \return true if mobility is enabled.
* @return true if mobility is enabled.
*/
bool IsMobility() const
{
@@ -119,9 +119,9 @@ class Experiment
}
/**
* \brief Get the Scenario number.
* @brief Get the Scenario number.
*
* \return the scenario number.
* @return the scenario number.
*/
uint32_t GetScenario() const
{
@@ -129,9 +129,9 @@ class Experiment
}
/**
* \brief Get the RTS Threshold.
* @brief Get the RTS Threshold.
*
* \return the RTS Threshold.
* @return the RTS Threshold.
*/
std::string GetRtsThreshold() const
{
@@ -139,9 +139,9 @@ class Experiment
}
/**
* \brief Get the Output File Name.
* @brief Get the Output File Name.
*
* \return the Output File Name.
* @return the Output File Name.
*/
std::string GetOutputFileName() const
{
@@ -149,9 +149,9 @@ class Experiment
}
/**
* \brief Get the Rate Manager.
* @brief Get the Rate Manager.
*
* \return the Rate Manager.
* @return the Rate Manager.
*/
std::string GetRateManager() const
{
@@ -160,34 +160,34 @@ class Experiment
private:
/**
* \brief Setup the receiving socket.
* @brief Setup the receiving socket.
*
* \param node The receiving node.
* \return the Rx socket.
* @param node The receiving node.
* @return the Rx socket.
*/
Ptr<Socket> SetupPacketReceive(Ptr<Node> node);
/**
* Generate 1-hop and 2-hop neighbors of a node in grid topology
* \param c The node container.
* \param senderId The sender ID.
* \return the neighbor nodes.
* @param c The node container.
* @param senderId The sender ID.
* @return the neighbor nodes.
*/
NodeContainer GenerateNeighbors(NodeContainer c, uint32_t senderId);
/**
* \brief Setup the application in the nodes.
* @brief Setup the application in the nodes.
*
* \param client Client node.
* \param server Server node.
* \param start Start time.
* \param stop Stop time.
* @param client Client node.
* @param server Server node.
* @param start Start time.
* @param stop Stop time.
*/
void ApplicationSetup(Ptr<Node> client, Ptr<Node> server, double start, double stop);
/**
* Take the grid map, divide it into 4 quadrants
* Assign all nodes from each quadrant to a specific container
*
* \param c The node container.
* @param c The node container.
*/
void AssignNeighbors(NodeContainer c);
/**
@@ -195,25 +195,25 @@ class Experiment
* may be the source for multiple destinations and a node maybe a destination
* for multiple sources.
*
* \param c The node container.
* @param c The node container.
*/
void SelectSrcDest(NodeContainer c);
/**
* \brief Receive a packet.
* @brief Receive a packet.
*
* \param socket The receiving socket.
* @param socket The receiving socket.
*/
void ReceivePacket(Ptr<Socket> socket);
/**
* \brief Calculate the throughput.
* @brief Calculate the throughput.
*/
void CheckThroughput();
/**
* A sender node will set up a flow to each of the its neighbors
* in its quadrant randomly. All the flows are exponentially distributed.
*
* \param sender The sender node.
* \param c The node neighbors.
* @param sender The sender node.
* @param c The node neighbors.
*/
void SendMultiDestinations(Ptr<Node> sender, NodeContainer c);
@@ -425,9 +425,9 @@ Experiment::SendMultiDestinations(Ptr<Node> sender, NodeContainer c)
/**
* Print the position of two nodes.
*
* \param client Client node.
* \param server Server node.
* \return a string with the nodes data and positions
* @param client Client node.
* @param server Server node.
* @return a string with the nodes data and positions
*/
static inline std::string
PrintPosition(Ptr<Node> client, Ptr<Node> server)

106
examples/wireless/wifi-power-adaptation-distance.cc
View File

@@ -17,12 +17,12 @@
* into an eps file, by running:
* \code{.sh}
* gnuplot throughput-parf.plt
* \endcode
* @endcode
* Also, to enable logging of rate and power changes to the terminal, set this
* environment variable:
* \code{.sh}
* export NS_LOG=PowerAdaptationDistance=level_info
* \endcode
* @endcode
*
* This simulation consist of 2 nodes, one AP and one STA.
* The AP generates UDP traffic with a CBR of 54 Mbps to the STA.
@@ -55,7 +55,7 @@
* To display all the possible arguments and their defaults:
* \code{.sh}
* ./ns3 run "wifi-power-adaptation-distance --help"
* \endcode
* @endcode
*
* Example usage (selecting Aparf rather than Parf):
* \code{.sh}
@@ -70,7 +70,7 @@
* To enable the log of rate and power changes:
* \code{.sh}
* export NS_LOG=PowerAdaptationDistance=level_info
* \endcode
* @endcode
*/
#include "ns3/command-line.h"
@@ -100,85 +100,85 @@ NS_LOG_COMPONENT_DEFINE("PowerAdaptationDistance");
static const uint32_t packetSize = 1420;
/**
* \brief Class to collect node statistics.
* @brief Class to collect node statistics.
*/
class NodeStatistics
{
public:
/**
* \brief Constructor.
* @brief Constructor.
*
* \param aps Access points
* \param stas WiFi Stations.
* @param aps Access points
* @param stas WiFi Stations.
*/
NodeStatistics(NetDeviceContainer aps, NetDeviceContainer stas);
/**
* \brief Callback called by WifiNetDevice/Phy/PhyTxBegin.
* @brief Callback called by WifiNetDevice/Phy/PhyTxBegin.
*
* \param path The trace path.
* \param packet The sent packet.
* \param powerW The Tx power.
* @param path The trace path.
* @param packet The sent packet.
* @param powerW The Tx power.
*/
void PhyCallback(std::string path, Ptr<const Packet> packet, double powerW);
/**
* \brief Callback called by PacketSink/Rx.
* @brief Callback called by PacketSink/Rx.
*
* \param path The trace path.
* \param packet The received packet.
* \param from The sender address.
* @param path The trace path.
* @param packet The received packet.
* @param from The sender address.
*/
void RxCallback(std::string path, Ptr<const Packet> packet, const Address& from);
/**
* \brief Callback called by WifiNetDevice/RemoteStationManager/x/PowerChange.
* @brief Callback called by WifiNetDevice/RemoteStationManager/x/PowerChange.
*
* \param path The trace path.
* \param oldPower Old Tx power.
* \param newPower Actual Tx power.
* \param dest Destination of the transmission.
* @param path The trace path.
* @param oldPower Old Tx power.
* @param newPower Actual Tx power.
* @param dest Destination of the transmission.
*/
void PowerCallback(std::string path, double oldPower, double newPower, Mac48Address dest);
/**
* \brief Callback called by WifiNetDevice/RemoteStationManager/x/RateChange.
* @brief Callback called by WifiNetDevice/RemoteStationManager/x/RateChange.
*
* \param path The trace path.
* \param oldRate Old rate.
* \param newRate Actual rate.
* \param dest Destination of the transmission.
* @param path The trace path.
* @param oldRate Old rate.
* @param newRate Actual rate.
* @param dest Destination of the transmission.
*/
void RateCallback(std::string path, DataRate oldRate, DataRate newRate, Mac48Address dest);
/**
* \brief Set the Position of a node.
* @brief Set the Position of a node.
*
* \param node The node.
* \param position The position.
* @param node The node.
* @param position The position.
*/
void SetPosition(Ptr<Node> node, Vector position);
/**
* Move a node.
* \param node The node.
* \param stepsSize The step size.
* \param stepsTime Time on each step.
* @param node The node.
* @param stepsSize The step size.
* @param stepsTime Time on each step.
*/
void AdvancePosition(Ptr<Node> node, int stepsSize, Time stepsTime);
/**
* \brief Get the Position of a node.
* @brief Get the Position of a node.
*
* \param node The node.
* \return the position of the node.
* @param node The node.
* @return the position of the node.
*/
Vector GetPosition(Ptr<Node> node);
/**
* \brief Get the Throughput output data
* @brief Get the Throughput output data
*
* \return the Throughput output data.
* @return the Throughput output data.
*/
Gnuplot2dDataset GetDatafile();
/**
* \brief Get the Power output data.
* @brief Get the Power output data.
*
* \return the Power output data.
* @return the Power output data.
*/
Gnuplot2dDataset GetPowerDatafile();
@@ -186,16 +186,16 @@ class NodeStatistics
/// Time, DataRate pair vector.
typedef std::vector<std::pair<Time, DataRate>> TxTime;
/**
* \brief Setup the WifiPhy object.
* @brief Setup the WifiPhy object.
*
* \param phy The WifiPhy to setup.
* @param phy The WifiPhy to setup.
*/
void SetupPhy(Ptr<WifiPhy> phy);
/**
* \brief Get the time at which a given datarate has been recorded.
* @brief Get the time at which a given datarate has been recorded.
*
* \param rate The datarate to search.
* \return the time.
* @param rate The datarate to search.
* @return the time.
*/
Time GetCalcTxTime(DataRate rate);
@@ -351,10 +351,10 @@ NodeStatistics::GetPowerDatafile()
/**
* Callback called by WifiNetDevice/RemoteStationManager/x/PowerChange.
*
* \param path The trace path.
* \param oldPower Old Tx power.
* \param newPower Actual Tx power.
* \param dest Destination of the transmission.
* @param path The trace path.
* @param oldPower Old Tx power.
* @param newPower Actual Tx power.
* @param dest Destination of the transmission.
*/
void
PowerCallback(std::string path, double oldPower, double newPower, Mac48Address dest)
@@ -364,12 +364,12 @@ PowerCallback(std::string path, double oldPower, double newPower, Mac48Address d
}
/**
* \brief Callback called by WifiNetDevice/RemoteStationManager/x/RateChange.
* @brief Callback called by WifiNetDevice/RemoteStationManager/x/RateChange.
*
* \param path The trace path.
* \param oldRate Old rate.
* \param newRate Actual rate.
* \param dest Destination of the transmission.
* @param path The trace path.
* @param oldRate Old rate.
* @param newRate Actual rate.
* @param dest Destination of the transmission.
*/
void
RateCallback(std::string path, DataRate oldRate, DataRate newRate, Mac48Address dest)

116
examples/wireless/wifi-power-adaptation-interference.cc
View File

@@ -41,7 +41,7 @@
* To enable the log of rate and power changes:
* \code{.sh}
* export NS_LOG=PowerAdaptationInterference=level_info
* \endcode
* @endcode
*/
#include "ns3/command-line.h"
@@ -72,111 +72,111 @@ NS_LOG_COMPONENT_DEFINE("PowerAdaptationInterference");
static const uint32_t packetSize = 1420;
/**
* \brief Class to collect node statistics.
* @brief Class to collect node statistics.
*/
class NodeStatistics
{
public:
/**
* \brief Constructor.
* @brief Constructor.
*
* \param aps Access points
* \param stas WiFi Stations.
* @param aps Access points
* @param stas WiFi Stations.
*/
NodeStatistics(NetDeviceContainer aps, NetDeviceContainer stas);
/**
* \brief Collects the statistics at a given time.
* @brief Collects the statistics at a given time.
*
* \param time Time at which the statistics are collected.
* @param time Time at which the statistics are collected.
*/
void CheckStatistics(double time);
/**
* \brief Callback called by WifiNetDevice/Phy/PhyTxBegin.
* @brief Callback called by WifiNetDevice/Phy/PhyTxBegin.
*
* \param path The trace path.
* \param packet The sent packet.
* \param powerW The Tx power.
* @param path The trace path.
* @param packet The sent packet.
* @param powerW The Tx power.
*/
void PhyCallback(std::string path, Ptr<const Packet> packet, double powerW);
/**
* \brief Callback called by PacketSink/Rx.
* @brief Callback called by PacketSink/Rx.
*
* \param path The trace path.
* \param packet The received packet.
* \param from The sender address.
* @param path The trace path.
* @param packet The received packet.
* @param from The sender address.
*/
void RxCallback(std::string path, Ptr<const Packet> packet, const Address& from);
/**
* \brief Callback called by WifiNetDevice/RemoteStationManager/x/PowerChange.
* @brief Callback called by WifiNetDevice/RemoteStationManager/x/PowerChange.
*
* \param path The trace path.
* \param oldPower Old Tx power.
* \param newPower Actual Tx power.
* \param dest Destination of the transmission.
* @param path The trace path.
* @param oldPower Old Tx power.
* @param newPower Actual Tx power.
* @param dest Destination of the transmission.
*/
void PowerCallback(std::string path, double oldPower, double newPower, Mac48Address dest);
/**
* \brief Callback called by WifiNetDevice/RemoteStationManager/x/RateChange.
* @brief Callback called by WifiNetDevice/RemoteStationManager/x/RateChange.
*
* \param path The trace path.
* \param oldRate Old rate.
* \param newRate Actual rate.
* \param dest Destination of the transmission.
* @param path The trace path.
* @param oldRate Old rate.
* @param newRate Actual rate.
* @param dest Destination of the transmission.
*/
void RateCallback(std::string path, DataRate oldRate, DataRate newRate, Mac48Address dest);
/**
* \brief Callback called by YansWifiPhy/State/State.
* @brief Callback called by YansWifiPhy/State/State.
*
* \param path The trace path.
* \param init Time when the state started.
* \param duration Amount of time we've been in (or will be in) the state.
* \param state The state.
* @param path The trace path.
* @param init Time when the state started.
* @param duration Amount of time we've been in (or will be in) the state.
* @param state The state.
*/
void StateCallback(std::string path, Time init, Time duration, WifiPhyState state);
/**
* \brief Get the Throughput output data
* @brief Get the Throughput output data
*
* \return the Throughput output data.
* @return the Throughput output data.
*/
Gnuplot2dDataset GetDatafile();
/**
* \brief Get the Power output data.
* @brief Get the Power output data.
*
* \return the Power output data.
* @return the Power output data.
*/
Gnuplot2dDataset GetPowerDatafile();
/**
* \brief Get the IDLE state output data.
* @brief Get the IDLE state output data.
*
* \return the IDLE state output data.
* @return the IDLE state output data.
*/
Gnuplot2dDataset GetIdleDatafile();
/**
* \brief Get the BUSY state output data.
* @brief Get the BUSY state output data.
*
* \return the BUSY state output data.
* @return the BUSY state output data.
*/
Gnuplot2dDataset GetBusyDatafile();
/**
* \brief Get the TX state output data.
* @brief Get the TX state output data.
*
* \return the TX state output data.
* @return the TX state output data.
*/
Gnuplot2dDataset GetTxDatafile();
/**
* \brief Get the RX state output data.
* @brief Get the RX state output data.
*
* \return the RX state output data.
* @return the RX state output data.
*/
Gnuplot2dDataset GetRxDatafile();
/**
* \brief Get the Busy time.
* @brief Get the Busy time.
*
* \return the busy time.
* @return the busy time.
*/
double GetBusyTime() const;
@@ -184,16 +184,16 @@ class NodeStatistics
/// Time, DataRate pair vector.
typedef std::vector<std::pair<Time, DataRate>> TxTime;
/**
* \brief Setup the WifiPhy object.
* @brief Setup the WifiPhy object.
*
* \param phy The WifiPhy to setup.
* @param phy The WifiPhy to setup.
*/
void SetupPhy(Ptr<WifiPhy> phy);
/**
* \brief Get the time at which a given datarate has been recorded.
* @brief Get the time at which a given datarate has been recorded.
*
* \param rate The datarate to search.
* \return the time.
* @param rate The datarate to search.
* @return the time.
*/
Time GetCalcTxTime(DataRate rate);
@@ -413,10 +413,10 @@ NodeStatistics::GetBusyTime() const
/**
* Callback called by WifiNetDevice/RemoteStationManager/x/PowerChange.
*
* \param path The trace path.
* \param oldPower Old Tx power.
* \param newPower Actual Tx power.
* \param dest Destination of the transmission.
* @param path The trace path.
* @param oldPower Old Tx power.
* @param newPower Actual Tx power.
* @param dest Destination of the transmission.
*/
void
PowerCallback(std::string path, double oldPower, double newPower, Mac48Address dest)
@@ -426,12 +426,12 @@ PowerCallback(std::string path, double oldPower, double newPower, Mac48Address d
}
/**
* \brief Callback called by WifiNetDevice/RemoteStationManager/x/RateChange.
* @brief Callback called by WifiNetDevice/RemoteStationManager/x/RateChange.
*
* \param path The trace path.
* \param oldRate Old rate.
* \param newRate Actual rate.
* \param dest Destination of the transmission.
* @param path The trace path.
* @param oldRate Old rate.
* @param newRate Actual rate.
* @param dest Destination of the transmission.
*/
void
RateCallback(std::string path, DataRate oldRate, DataRate newRate, Mac48Address dest)

30
examples/wireless/wifi-rate-adaptation-distance.cc
View File

@@ -70,39 +70,39 @@ class NodeStatistics
public:
/**
* Constructor
* \param aps AP devices
* \param stas STA devices
* @param aps AP devices
* @param stas STA devices
*/
NodeStatistics(NetDeviceContainer aps, NetDeviceContainer stas);
/**
* RX callback
* \param path path
* \param packet received packet
* \param from sender
* @param path path
* @param packet received packet
* @param from sender
*/
void RxCallback(std::string path, Ptr<const Packet> packet, const Address& from);
/**
* Set node position
* \param node the node
* \param position the position
* @param node the node
* @param position the position
*/
void SetPosition(Ptr<Node> node, Vector position);
/**
* Advance node position
* \param node the node
* \param stepsSize the size of a step
* \param stepsTime the time interval between steps
* @param node the node
* @param stepsSize the size of a step
* @param stepsTime the time interval between steps
*/
void AdvancePosition(Ptr<Node> node, int stepsSize, int stepsTime);
/**
* Get node position
* \param node the node
* \return the position
* @param node the node
* @return the position
*/
Vector GetPosition(Ptr<Node> node);
/**
* \return the gnuplot 2d dataset
* @return the gnuplot 2d dataset
*/
Gnuplot2dDataset GetDatafile();
@@ -162,8 +162,8 @@ NodeStatistics::GetDatafile()
/**
* Callback for 'Rate' trace source
*
* \param oldRate old MCS rate (bits/sec)
* \param newRate new MCS rate (bits/sec)
* @param oldRate old MCS rate (bits/sec)
* @param newRate new MCS rate (bits/sec)
*/
void
RateCallback(uint64_t oldRate, uint64_t newRate)

10
examples/wireless/wifi-simple-adhoc-grid.cc
View File

@@ -97,7 +97,7 @@ NS_LOG_COMPONENT_DEFINE("WifiSimpleAdhocGrid");
/**
* Function called when a packet is received.
*
* \param socket The receiving socket.
* @param socket The receiving socket.
*/
void
ReceivePacket(Ptr<Socket> socket)
@@ -111,10 +111,10 @@ ReceivePacket(Ptr<Socket> socket)
/**
* Generate traffic.
*
* \param socket The sending socket.
* \param pktSize The packet size.
* \param pktCount The packet count.
* \param pktInterval The interval between two packets.
* @param socket The sending socket.
* @param pktSize The packet size.
* @param pktCount The packet count.
* @param pktInterval The interval between two packets.
*/
static void
GenerateTraffic(Ptr<Socket> socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)

10
examples/wireless/wifi-simple-adhoc.cc
View File

@@ -57,7 +57,7 @@ NS_LOG_COMPONENT_DEFINE("WifiSimpleAdhoc");
/**
* Function called when a packet is received.
*
* \param socket The receiving socket.
* @param socket The receiving socket.
*/
void
ReceivePacket(Ptr<Socket> socket)
@@ -71,10 +71,10 @@ ReceivePacket(Ptr<Socket> socket)
/**
* Generate traffic.
*
* \param socket The sending socket.
* \param pktSize The packet size.
* \param pktCount The packet count.
* \param pktInterval The interval between two packets.
* @param socket The sending socket.
* @param pktSize The packet size.
* @param pktCount The packet count.
* @param pktInterval The interval between two packets.
*/
static void
GenerateTraffic(Ptr<Socket> socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)

10
examples/wireless/wifi-simple-infra.cc
View File

@@ -89,7 +89,7 @@ NS_LOG_COMPONENT_DEFINE("WifiSimpleInfra");
/**
* Function called when a packet is received.
*
* \param socket The receiving socket.
* @param socket The receiving socket.
*/
void
ReceivePacket(Ptr<Socket> socket)
@@ -103,10 +103,10 @@ ReceivePacket(Ptr<Socket> socket)
/**
* Generate traffic.
*
* \param socket The sending socket.
* \param pktSize The packet size.
* \param pktCount The packet count.
* \param pktInterval The interval between two packets.
* @param socket The sending socket.
* @param pktSize The packet size.
* @param pktCount The packet count.
* @param pktInterval The interval between two packets.
*/
static void
GenerateTraffic(Ptr<Socket> socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)

14
examples/wireless/wifi-simple-interference.cc
View File

@@ -87,8 +87,8 @@ NS_LOG_COMPONENT_DEFINE("WifiSimpleInterference");
/**
* Print a packer that has been received.
*
* \param socket The receiving socket.
* \return a string with the packet details.
* @param socket The receiving socket.
* @return a string with the packet details.
*/
static inline std::string
PrintReceivedPacket(Ptr<Socket> socket)
@@ -111,7 +111,7 @@ PrintReceivedPacket(Ptr<Socket> socket)
/**
* Function called when a packet is received.
*
* \param socket The receiving socket.
* @param socket The receiving socket.
*/
static void
ReceivePacket(Ptr<Socket> socket)
@@ -122,10 +122,10 @@ ReceivePacket(Ptr<Socket> socket)
/**
* Generate traffic
*
* \param socket The seding socket.
* \param pktSize The packet size.
* \param pktCount The packet counter.
* \param pktInterval The interval between two packets.
* @param socket The seding socket.
* @param pktSize The packet size.
* @param pktCount The packet counter.
* @param pktInterval The interval between two packets.
*/
static void
GenerateTraffic(Ptr<Socket> socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)

16
examples/wireless/wifi-sleep.cc
View File

@@ -58,9 +58,9 @@ NS_LOG_COMPONENT_DEFINE("WifiSleep");
/**
* Remaining energy trace sink
*
* \tparam node The node ID this trace belongs to.
* \param oldValue Old value.
* \param newValue New value.
* @tparam node The node ID this trace belongs to.
* @param oldValue Old value.
* @param newValue New value.
*/
template <int node>
void
@@ -77,11 +77,11 @@ RemainingEnergyTrace(double oldValue, double newValue)
/**
* PHY state trace sink
*
* \tparam node The node ID this trace belongs to.
* \param context The context
* \param start Start time for the current state
* \param duration Duratio of the current state
* \param state State
* @tparam node The node ID this trace belongs to.
* @param context The context
* @param start Start time for the current state
* @param duration Duratio of the current state
* @param state State
*/
template <int node>
void

12
examples/wireless/wifi-spectrum-per-example.cc
View File

@@ -91,12 +91,12 @@ uint32_t g_samples; //!< Number of samples
/**
* Monitor sniffer Rx trace
*
* \param packet The sensed packet.
* \param channelFreqMhz The channel frequency [MHz].
* \param txVector The Tx vector.
* \param aMpdu The aMPDU.
* \param signalNoise The signal and noise dBm.
* \param staId The STA ID.
* @param packet The sensed packet.
* @param channelFreqMhz The channel frequency [MHz].
* @param txVector The Tx vector.
* @param aMpdu The aMPDU.
* @param signalNoise The signal and noise dBm.
* @param staId The STA ID.
*/
void
MonitorSniffRx(Ptr<const Packet> packet,

12
examples/wireless/wifi-spectrum-per-interference.cc
View File

@@ -97,12 +97,12 @@ uint32_t g_samples; //!< Number of samples
/**
* Monitor sniffer Rx trace
*
* \param packet The sensed packet.
* \param channelFreqMhz The channel frequency [MHz].
* \param txVector The Tx vector.
* \param aMpdu The aMPDU.
* \param signalNoise The signal and noise dBm.
* \param staId The STA ID.
* @param packet The sensed packet.
* @param channelFreqMhz The channel frequency [MHz].
* @param txVector The Tx vector.
* @param aMpdu The aMPDU.
* @param signalNoise The signal and noise dBm.
* @param staId The STA ID.
*/
void
MonitorSniffRx(Ptr<const Packet> packet,

6
examples/wireless/wifi-txop-aggregation.cc
View File

@@ -77,9 +77,9 @@ struct TxopDurationTracer
/**
* Callback connected to TXOP duration trace source.
*
* \param startTime TXOP start time
* \param duration TXOP duration
* \param linkId the ID of the link
* @param startTime TXOP start time
* @param duration TXOP duration
* @param linkId the ID of the link
*/
void Trace(Time startTime, Time duration, uint8_t linkId);
Time m_max; //!< maximum TXOP duration