Nsnam - User contributions [en]

Doxygen-warnings

2013-11-26T22:02:43Z

Nikkipui: wifi module, one typo

{{TOC}}

= Doxygen warning removal =

This page is to help coordinating the efforts in fixing [http://www.nsnam.org/bugzilla/show_bug.cgi?id=938 Bug 938: missing Doxygen in ns-3].

As a followup of [http://www.nsnam.org/wiki/Sprints Friday November 15 ns-3 Sprint], we'd like to coordinate the efforts of Doxygen warning removal.

It must be pointed out that warning removing is not good per-se. It is a way to complete the documentation and make it better.<br />

Undocumented functions leads to poor coding and, ultimately, not be able to use the ns-3 full power.<br />

Moreover, bad or missing documentation means '''bugs''' !

= Doxygen work status =
The following table might seems overwhelming. And the warning are just the ones in the model and helper folders.<br />

However, mind that many are chain-warnings, meaning that once you fix the master one in the base class, many of them will disappear. More on that at the bottom of the page.

The current doxygen warning status, by module is:
{| class="wikitable"
|-
! Number of warnings !! Module !! Who's working on it
|-

| 4086 || lte ||
|-
| 1903 || wifi || Daniel L.
|-
| 1727 || wimax ||
|-
| 1416 || core ||
|-
| 696 || network ||
|-
| 466 || mesh ||
|-
| 368 || uan ||
|-
| 363 || dsr ||
|-
| 259 || mobility ||
|-
| 237 || spectrum ||
|-
| 209 || propagation ||
|-
| 191 || olsr ||
|-
| 188 || applications ||
|-
| 171 || stats ||
|-
| 133 || netanim ||
|-
| 133 || config-store ||
|-
| 129 || visualizer ||
|-
| 126 || buildings ||
|-
| 84 || energy ||
|-
| 48 || openflow ||
|-
| 47 || point-to-point ||
|-
| 46 || dsdv ||
|-
| 41 || point-to-point-layout ||
|-
| 39 || mpi ||
|-
| 38 || aodv ||
|-
| 33 || fd-net-device ||
|-
| 30 || bridge ||
|-
| 24 || brite ||
|-
| 22 || nix-vector-routing ||
|-
| 21 || antenna ||
|-
| 18 || emu ||
|-
| 17 || virtual-net-device ||
|-
| 16 || csma ||
|-
| 11 || tap-bridge ||
|-
| 8 || csma-layout ||
|}

= How to proceed =
The procedure is simple.
# Post online that you're working on a module. Eventually coordinate with who's already working on the same module.
# Follow the direction in the [http://www.nsnam.org/wiki/Sprints Sprint] page to setup Doxygen to show you the warnings.
# Start with base classes. Mind that ''virtual'' functions can (and should) be documented only in the base class.
# Don't be afraid of the numbers. I was able to kill 1400 warnings in 2 days (just in my spare time).
# Once you have a patch, post it in Bugzilla: [http://www.nsnam.org/bugzilla/show_bug.cgi?id=938 Bug 938: missing Doxygen in ns-3].
# Go drink a beer, you deserve it.

= Hint and tips =

The doxygen.warnings.report.sh script will make a long list of warnings. You're probably interested in the ones from a single module. The following command might help:

grep <module name> doc/doxygen.warnings.log | sort > doc/my.doxygen.warnings.txt
Now you have a shorter list of bugs to work with. Cut out the ones from the tests and examples (or not, depends on how pedantic you are). Those are your warnings to kill.

--[[User:Tommaso|Tommaso]] ([[User talk:Tommaso|talk]]) 16:29, 26 November 2013 (EST)

HOWTO add basic rates to 802.11

2013-10-15T23:04:24Z

Nikkipui:

{{TOC}}

The 802.11 standard is quite clear on the rules for selection of transmission parameters for control response frames (e.g. CTS and ACK). ns-3 follows the standard and selects the rate of control response frames from the set of basic rates or mandatory rates. This means that control response frames may be sent using different rate even though the <code>ConstantRateWifiManager</code> is used. The <code>ControlMode</code> attribute of the <code>ConstantRateWifiManager</code> is used for RTS frames only. The rate of CTS and ACK frames are selected according to the 802.11 standard.

However, several real 802.11 drivers allow changing the rate of all control frames. To accomplish this in ns-3, you can manually add WifiMode to the basic rate set.

== HOWTO add basic rates to 802.11 ==

Here's an example of how you can add basic rates to 802.11b.

// Add the DSSS/CCK rates as the basic rates of our AP
Ptr<WifiRemoteStationManager> apStationManager = DynamicCast<WifiNetDevice>(apDev.Get (0))->GetRemoteStationManager ();
apStationManager->AddBasicMode (WifiMode ("DsssRate1Mbps"));
apStationManager->AddBasicMode (WifiMode ("DsssRate2Mbps"));
apStationManager->AddBasicMode (WifiMode ("DsssRate5_5Mbps"));
apStationManager->AddBasicMode (WifiMode ("DsssRate11Mbps"));

Please be aware that the rate you are adding must be supported by the PHY layer.

HOWTO add basic rates to 802.11

2013-10-15T13:22:19Z

Nikkipui: Add a new page "HOWTO add basic rates to 802.11"

{{TOC}}

The 802.11 standard is quite clear on the rules for selection of transmission parameters for control response frames (e.g. CTS and ACK). ns-3 follows the standard and selects the rate of control response frames from the set of basic rates or mandatory rates. This means that control response frames may be sent using different rate even though the ConstantRateWifiManager is used. The “ControlMode” attribute of the ConstantRateWifiManager is used for RTS frames only. The rate of CTS and ACK frames are selected according to the 802.11 standard.

However, several real 802.11 drivers allow changing the rate of all control frames. To accomplish this in ns-3, you can manually add WifiMode to the basic rate set.

== HOWTO add basic rates to 802.11 ==

Here's an example of how you can add basic rates to 802.11b.

// Add the DSSS/CCK rates as the basic rates of our AP
Ptr<WifiRemoteStationManager> apStationManager = DynamicCast<WifiNetDevice>(apDev.Get (0))->GetRemoteStationManager ();
apStationManager->AddBasicMode (WifiMode ("DsssRate1Mbps"));
apStationManager->AddBasicMode (WifiMode ("DsssRate2Mbps"));
apStationManager->AddBasicMode (WifiMode ("DsssRate5_5Mbps"));
apStationManager->AddBasicMode (WifiMode ("DsssRate11Mbps"));

Please be aware that the rate you are adding must be supported by the PHY layer.

HOWTOs

2013-10-15T12:39:45Z

Nikkipui:

{{TOC}}
== How to do Various Interesting Things with ns-3 ==

=== System-Related Items ===
* [[HOWTO make ns-3 interact with the real world]]
* [[HOWTO use VirtualBox to run simulations on Windows machines]]
* [[HOWTO get ns-3 running on Mac OS X (10.5.2 Intel)]]
* [[HOWTO get ns-3 running on Mac OS X (10.6.2 Intel)]]
* [[HOWTO Use Linux Containers to set up virtual networks]]
* [[HOWTO use VMware to set up virtual networks (Windows)]]
* [[HOWTO use ns-3 scripts to drive real hardware (experimental)]]
* [[HOWTO use ns-3 directly on the ORBIT testbed hardware]]
* [[HOWTO use ns-3 in the ORBIT testbed environment]]
* [[HOWTO use ns-3 directly on the CMU wireless emulator]]
* [[HOWTO use ns-3 with other libraries]]
* [[HOWTO use ns-3 on Windows with Visual Studio 2010]]
* [[HOWTO use ns-3 with BonnMotion mobility generator and analysis tool]]

=== Programming-Related Items ===
* [[HOWTO make and use a new application]]
* [[HOWTO extract the IP src/dst address from a packet]]
* [[HOWTO create a new type of protocol header or trailer]]
* [[HOWTO use null callbacks]]
* [[HOWTO create a new OSI layer 1 + 2 implementation]]
* [[HOWTO create a traffic generator]]
* [[HOWTO determine the path of an attribute or trace source]]
* [[HOWTO use the ConfigStore]]
* [[HOWTO determine all the available Values]]
* [http://www.eg.bucknell.edu/~perrone/2010/08/19/looking-at-ns-3-packet-traces/ HOWTO work with ns-3 packet traces]
* [http://www.eg.bucknell.edu/~perrone/2010/08/27/creating-a-new-module-in-ns-3/ HOWTO create a new module in ns-3]
* [[HOWTO enable a subset of ns-3's modules]]
* [[HOWTO enable/disable examples and tests in ns-3]]
* [[HOWTO resolve circular references in ns-3 memory disposal]]

==== IDE Integration ====
* [[HOWTO configure Eclipse with ns-3]]
* [[HOWTO configure NetBeans with ns-3]]
* [[HOWTO configure QtCreator with ns-3]]

=== Debugging-Related Items ===
* [[HOWTO use NS_LOG to find a problem]]
* [[HOWTO understand and find cause of terminated with signal errors]]
* [[HOWTO debug smart pointer | HOWTO debug smart pointers and packet pointers]]
* [[HOWTO use Valgrind to debug memory problems]]
* [[HOWTO resolve circular references in ns-3 memory disposal]]
* [[HOWTO build old versions of ns-3 on newer compilers]]
* [[HOWTO use oprofile]] to profile your ns-3 program

=== Mercurial-Related Items ===
* [[HOWTO use Mercurial Queues to manage your ns-3 patches]]

=== Data Analysis-Related Items ===
* [[HOWTO get ns-3 data into SciPy]]
* [[HOWTO get ns-3 data into ROOT]]
* [[HOWTO get ns-3 data into SciLab]]
* [[HOWTO get ns-3 data into Octave]]
* [[HOWTO get ns-3 to detect steady-state times in your data]]

=== Code Review-Related Items ===
* [[HOWTO use the coding style tool]]
* [[HOWTO control Rietveld patch generation]]

=== WiFi Model-Related Items ===
* [[HOWTO add basic rates to 802.11]]

----
[[User:Craigdo|Craigdo]] 16:34, 22 April 2010 (UTC)