A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
introspected-command-line.h
Go to the documentation of this file.
1/**
2 * @file
3 * @ingroup utils
4 * Doxygen docs generated from the ns3::CommandLine options for each example.
5 * @note This file is automatically generated by
6 * ns3::CommandLine::PrintDoxygenUsage() from the ns3::CommandLine configuration
7 * in various example programs. Do not edit this file! Edit the
8 * ns3::CommandLine configuration in those files instead.
9 */
10/**
11 @file adaptive-red-tests.cc
12<h3>Usage</h3>
13<code>$ ./ns3 run "adaptive-red-tests [Program Options]"</code>
14
15<h3>Program Options</h3>
16<dl>
17 <dt>@c --testNumber </dt>
18 <dd>Run test 1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14 or 15 [1] </dd>
19 <dt>@c --pathOut </dt>
20 <dd>Path to save results from --writeForPlot/--writePcap/--writeFlowMonitor [.] </dd>
21 <dt>@c --writeForPlot </dt>
22 <dd>Write results for plot (gnuplot) [false] </dd>
23 <dt>@c --writePcap </dt>
24 <dd>Write results in pcapfile [false] </dd>
25 <dt>@c --writeFlowMonitor </dt>
26 <dd>Enable Flow Monitor and write their results [false] </dd>
27</dl>
28*/
29/**
30 @file adhoc-aloha-ideal-phy.cc
31<h3>Usage</h3>
32<code>$ ./ns3 run "adhoc-aloha-ideal-phy [Program Options]"</code>
33
34<h3>Program Options</h3>
35<dl>
36 <dt>@c --verbose </dt>
37 <dd>Print trace information if true [false] </dd>
38</dl>
39*/
40/**
41 @file adhoc-aloha-ideal-phy-matrix-propagation-loss-model.cc
42<h3>Usage</h3>
43<code>$ ./ns3 run "adhoc-aloha-ideal-phy-matrix-propagation-loss-model [Program Options]"</code>
44
45<h3>Program Options</h3>
46<dl>
47 <dt>@c --verbose </dt>
48 <dd>Print trace information if true [false] </dd>
49 <dt>@c --lossDb </dt>
50 <dd>link loss in dB [130] </dd>
51 <dt>@c --txPowerW </dt>
52 <dd>txPower in Watts [0.1] </dd>
53 <dt>@c --phyRate </dt>
54 <dd>PHY rate in bps [500000] </dd>
55 <dt>@c --pktSize </dt>
56 <dd>packet size in bytes [1000] </dd>
57 <dt>@c --simDuration </dt>
58 <dd>duration of the simulation in seconds [0.5] </dd>
59 <dt>@c --channelType </dt>
60 <dd>which SpectrumChannel implementation to be used [ns3::SingleModelSpectrumChannel] </dd>
61</dl>
62*/
63/**
64 @file adhoc-aloha-ideal-phy-with-microwave-oven.cc
65<h3>Usage</h3>
66<code>$ ./ns3 run "adhoc-aloha-ideal-phy-with-microwave-oven [Program Options]"</code>
67
68<h3>Program Options</h3>
69<dl>
70 <dt>@c --verbose </dt>
71 <dd>Print trace information if true [false] </dd>
72</dl>
73*/
74/**
75 @file buildings-pathloss-profiler.cc
76<h3>Usage</h3>
77<code>$ ./ns3 run "buildings-pathloss-profiler [Program Options]"</code>
78
79<h3>Program Options</h3>
80<dl>
81 <dt>@c --hEnb </dt>
82 <dd>Height of the eNB [30] </dd>
83 <dt>@c --hUe </dt>
84 <dd>Height of UE [1] </dd>
85 <dt>@c --enbIndoor </dt>
86 <dd>Boolean for eNB Indoor/Outdoor selection [false] </dd>
87 <dt>@c --ueIndoor </dt>
88 <dd>Boolean for UE Indoor/Outdoor selection [false] </dd>
89</dl>
90*/
91/**
92 @file codel-vs-pfifo-asymmetric.cc
93<h3>Usage</h3>
94<code>$ ./ns3 run "codel-vs-pfifo-asymmetric [Program Options]"</code>
95
96<h3>Program Options</h3>
97<dl>
98 <dt>@c --serverCmtsDelay </dt>
99 <dd>Link delay between server and CMTS [15ms] </dd>
100 <dt>@c --cmtsRouterDelay </dt>
101 <dd>Link delay between CMTS and rounter [6ms] </dd>
102 <dt>@c --routerHostDelay </dt>
103 <dd>Link delay between router and host [0.1ms] </dd>
104 <dt>@c --serverLanDataRate </dt>
105 <dd>Server LAN net device data rate [10Gbps] </dd>
106 <dt>@c --cmtsLanDataRate </dt>
107 <dd>CMTS LAN net device data rate [10Gbps] </dd>
108 <dt>@c --cmtsWanDataRate </dt>
109 <dd>CMTS WAN net device data rate [22Mbps] </dd>
110 <dt>@c --routerWanDataRate </dt>
111 <dd>Router WAN net device data rate [5Mbps] </dd>
112 <dt>@c --routerLanDataRate </dt>
113 <dd>Router LAN net device data rate [10Gbps] </dd>
114 <dt>@c --hostLanDataRate </dt>
115 <dd>Host LAN net device data rate [10Gbps] </dd>
116 <dt>@c --routerWanQueueDiscType </dt>
117 <dd>Router WAN queue disc type: PfifoFast, CoDel [CoDel] </dd>
118 <dt>@c --queueSize </dt>
119 <dd>Queue size in packets [1000] </dd>
120 <dt>@c --pktSize </dt>
121 <dd>Packet size in bytes [1458] </dd>
122 <dt>@c --numOfUpLoadBulkFlows </dt>
123 <dd>Number of upload bulk transfer flows [1] </dd>
124 <dt>@c --numOfDownLoadBulkFlows </dt>
125 <dd>Number of download bulk transfer flows [1] </dd>
126 <dt>@c --numOfUpLoadOnOffFlows </dt>
127 <dd>Number of upload OnOff flows [1] </dd>
128 <dt>@c --numOfDownLoadOnOffFlows </dt>
129 <dd>Number of download OnOff flows [1] </dd>
130 <dt>@c --startTime </dt>
131 <dd>Simulation start time [0.1] </dd>
132 <dt>@c --simDuration </dt>
133 <dd>Simulation duration in seconds [60] </dd>
134 <dt>@c --isPcapEnabled </dt>
135 <dd>Flag to enable/disable pcap [true] </dd>
136 <dt>@c --logging </dt>
137 <dd>Flag to enable/disable logging [true] </dd>
138</dl>
139*/
140/**
141 @file codel-vs-pfifo-basic-test.cc
142<h3>Usage</h3>
143<code>$ ./ns3 run "codel-vs-pfifo-basic-test [Program Options]"</code>
144
145<h3>Program Options</h3>
146<dl>
147 <dt>@c --bottleneckBandwidth </dt>
148 <dd>Bottleneck bandwidth [5Mbps] </dd>
149 <dt>@c --bottleneckDelay </dt>
150 <dd>Bottleneck delay [5ms] </dd>
151 <dt>@c --accessBandwidth </dt>
152 <dd>Access link bandwidth [100Mbps] </dd>
153 <dt>@c --accessDelay </dt>
154 <dd>Access link delay [0.1ms] </dd>
155 <dt>@c --queueDiscType </dt>
156 <dd>Bottleneck queue disc type: PfifoFast, CoDel [PfifoFast] </dd>
157 <dt>@c --queueDiscSize </dt>
158 <dd>Bottleneck queue disc size in packets [1000] </dd>
159 <dt>@c --queueSize </dt>
160 <dd>Devices queue size in packets [10] </dd>
161 <dt>@c --pktSize </dt>
162 <dd>Packet size in bytes [1458] </dd>
163 <dt>@c --startTime </dt>
164 <dd>Simulation start time [0.1] </dd>
165 <dt>@c --simDuration </dt>
166 <dd>Simulation duration in seconds [60] </dd>
167 <dt>@c --isPcapEnabled </dt>
168 <dd>Flag to enable/disable pcap [true] </dd>
169 <dt>@c --pcapFileName </dt>
170 <dd>Name of pcap file [pcapFilePfifoFast.pcap] </dd>
171 <dt>@c --cwndTrFileName </dt>
172 <dd>Name of cwnd trace file [cwndPfifoFast.tr] </dd>
173 <dt>@c --logging </dt>
174 <dd>Flag to enable/disable logging [false] </dd>
175</dl>
176*/
177/**
178 @file config-store-save.cc
179<h3>Usage</h3>
180<code>$ ./ns3 run "config-store-save [Program Options]"</code>
181Without arguments, write out ConfigStore defaults, globals, and
182test object ConfigExample attributes to text file output-attributes.txt
183and (when XML supported) output-attributes.xml. Optionally set
184attributes to write out using --load &lt;filename> where &lt;filename> is a
185previously saved config-store file to load.
186Observe load behavior by setting environment variable NS_LOG=RawTextConfig.
187
188<h3>Program Options</h3>
189<dl>
190 <dt>@c --load </dt>
191 <dd>Relative path to config-store input file </dd>
192</dl>
193*/
194/**
195 @file csma-bridge.cc
196<h3>Usage</h3>
197<code>$ ./ns3 run "csma-bridge"</code>
198*/
199/**
200 @file csma-bridge-one-hop.cc
201<h3>Usage</h3>
202<code>$ ./ns3 run "csma-bridge-one-hop"</code>
203*/
204/**
205 @file csma-broadcast.cc
206<h3>Usage</h3>
207<code>$ ./ns3 run "csma-broadcast"</code>
208*/
209/**
210 @file csma-multicast.cc
211<h3>Usage</h3>
212<code>$ ./ns3 run "csma-multicast"</code>
213*/
214/**
215 @file csma-one-subnet.cc
216<h3>Usage</h3>
217<code>$ ./ns3 run "csma-one-subnet"</code>
218*/
219/**
220 @file csma-packet-socket.cc
221<h3>Usage</h3>
222<code>$ ./ns3 run "csma-packet-socket"</code>
223*/
224/**
225 @file csma-ping.cc
226<h3>Usage</h3>
227<code>$ ./ns3 run "csma-ping [Program Options]"</code>
228
229<h3>Program Options</h3>
230<dl>
231 <dt>@c --verbose </dt>
232 <dd>print received background traffic packets and ping RTT values [false] </dd>
233</dl>
234*/
235/**
236 @file csma-raw-ip-socket.cc
237<h3>Usage</h3>
238<code>$ ./ns3 run "csma-raw-ip-socket [Program Options]"</code>
239
240<h3>Program Options</h3>
241<dl>
242 <dt>@c --dataRate </dt>
243 <dd>application dataRate (Kb/s) [10] </dd>
244</dl>
245*/
246/**
247 @file double-probe-example.cc
248<h3>Usage</h3>
249<code>$ ./ns3 run "double-probe-example"</code>
250*/
251/**
252 @file dumbbell-animation.cc
253<h3>Usage</h3>
254<code>$ ./ns3 run "dumbbell-animation [Program Options]"</code>
255
256<h3>Program Options</h3>
257<dl>
258 <dt>@c --nLeftLeaf </dt>
259 <dd>Number of left side leaf nodes [5] </dd>
260 <dt>@c --nRightLeaf </dt>
261 <dd>Number of right side leaf nodes [5] </dd>
262 <dt>@c --nLeaf </dt>
263 <dd>Number of left and right side leaf nodes [0] </dd>
264 <dt>@c --animFile </dt>
265 <dd>File Name for Animation Output [dumbbell-animation.xml] </dd>
266</dl>
267*/
268/**
269 @file dummy-network.cc
270<h3>Usage</h3>
271<code>$ ./ns3 run "dummy-network"</code>
272*/
273/**
274 @file dynamic-global-routing.cc
275<h3>Usage</h3>
276<code>$ ./ns3 run "dynamic-global-routing"</code>
277*/
278/**
279 @file energy-model-example.cc
280<h3>Usage</h3>
281<code>$ ./ns3 run "energy-model-example [Program Options]"</code>
282
283<h3>Program Options</h3>
284<dl>
285 <dt>@c --phyMode </dt>
286 <dd>Wifi Phy mode [DsssRate1Mbps] </dd>
287 <dt>@c --Prss </dt>
288 <dd>Intended primary RSS (dBm) [-80] </dd>
289 <dt>@c --PpacketSize </dt>
290 <dd>size of application packet sent [200] </dd>
291 <dt>@c --numPackets </dt>
292 <dd>Total number of packets to send [10000] </dd>
293 <dt>@c --startTime </dt>
294 <dd>Simulation start time [0] </dd>
295 <dt>@c --distanceToRx </dt>
296 <dd>X-Axis distance between nodes [100] </dd>
297 <dt>@c --verbose </dt>
298 <dd>Turn on all device log components [false] </dd>
299</dl>
300*/
301/**
302 @file energy-model-with-harvesting-example.cc
303<h3>Usage</h3>
304<code>$ ./ns3 run "energy-model-with-harvesting-example [Program Options]"</code>
305
306<h3>Program Options</h3>
307<dl>
308 <dt>@c --phyMode </dt>
309 <dd>Wifi Phy mode [DsssRate1Mbps] </dd>
310 <dt>@c --Prss </dt>
311 <dd>Intended primary RSS (dBm) [-80] </dd>
312 <dt>@c --PacketSize </dt>
313 <dd>size of application packet sent [200] </dd>
314 <dt>@c --numPackets </dt>
315 <dd>Total number of packets to send [10000] </dd>
316 <dt>@c --startTime </dt>
317 <dd>Simulation start time [0] </dd>
318 <dt>@c --distanceToRx </dt>
319 <dd>X-Axis distance between nodes [100] </dd>
320 <dt>@c --verbose </dt>
321 <dd>Turn on all device log components [false] </dd>
322</dl>
323*/
324/**
325 @file fd2fd-onoff.cc
326<h3>Usage</h3>
327<code>$ ./ns3 run "fd2fd-onoff [Program Options]"</code>
328
329<h3>Program Options</h3>
330<dl>
331 <dt>@c --tcpMode </dt>
332 <dd>1:true, 0:false, default mode UDP [false] </dd>
333</dl>
334*/
335/**
336 @file fifth.cc
337<h3>Usage</h3>
338<code>$ ./ns3 run "fifth"</code>
339*/
340/**
341 @file file-helper-example.cc
342<h3>Usage</h3>
343<code>$ ./ns3 run "file-helper-example"</code>
344*/
345/**
346 @file first.cc
347<h3>Usage</h3>
348<code>$ ./ns3 run "first"</code>
349*/
350/**
351 @file global-injection-slash32.cc
352<h3>Usage</h3>
353<code>$ ./ns3 run "global-injection-slash32"</code>
354*/
355/**
356 @file global-routing-slash32.cc
357<h3>Usage</h3>
358<code>$ ./ns3 run "global-routing-slash32"</code>
359*/
360/**
361 @file gnuplot-helper-example.cc
362<h3>Usage</h3>
363<code>$ ./ns3 run "gnuplot-helper-example"</code>
364*/
365/**
366 @file grid-animation.cc
367<h3>Usage</h3>
368<code>$ ./ns3 run "grid-animation [Program Options]"</code>
369
370<h3>Program Options</h3>
371<dl>
372 <dt>@c --xSize </dt>
373 <dd>Number of rows of nodes [5] </dd>
374 <dt>@c --ySize </dt>
375 <dd>Number of columns of nodes [5] </dd>
376 <dt>@c --animFile </dt>
377 <dd>File Name for Animation Output [grid-animation.xml] </dd>
378</dl>
379*/
380/**
381 @file icmpv6-redirect.cc
382<h3>Usage</h3>
383<code>$ ./ns3 run "icmpv6-redirect [Program Options]"</code>
384
385<h3>Program Options</h3>
386<dl>
387 <dt>@c --verbose </dt>
388 <dd>turn on log components [false] </dd>
389</dl>
390*/
391/**
392 @file lena-cqi-threshold.cc
393<h3>Usage</h3>
394<code>$ ./ns3 run "lena-cqi-threshold"</code>
395*/
396/**
397 @file lena-dual-stripe.cc
398<h3>Usage</h3>
399<code>$ ./ns3 run "lena-dual-stripe"</code>
400*/
401/**
402 @file lena-fading.cc
403<h3>Usage</h3>
404<code>$ ./ns3 run "lena-fading"</code>
405*/
406/**
407 @file lena-intercell-interference.cc
408<h3>Usage</h3>
409<code>$ ./ns3 run "lena-intercell-interference [Program Options]"</code>
410
411<h3>Program Options</h3>
412<dl>
413 <dt>@c --enbDist </dt>
414 <dd>distance between the two eNBs [100] </dd>
415 <dt>@c --radius </dt>
416 <dd>the radius of the disc where UEs are placed around an eNB [50] </dd>
417 <dt>@c --numUes </dt>
418 <dd>how many UEs are attached to each eNB [1] </dd>
419 <dt>@c --simTime </dt>
420 <dd>Total duration of the simulation (in seconds) [1] </dd>
421</dl>
422*/
423/**
424 @file lena-ipv6-addr-conf.cc
425<h3>Usage</h3>
426<code>$ ./ns3 run "lena-ipv6-addr-conf"</code>
427*/
428/**
429 @file lena-ipv6-ue-rh.cc
430<h3>Usage</h3>
431<code>$ ./ns3 run "lena-ipv6-ue-rh"</code>
432*/
433/**
434 @file lena-ipv6-ue-ue.cc
435<h3>Usage</h3>
436<code>$ ./ns3 run "lena-ipv6-ue-ue"</code>
437*/
438/**
439 @file lena-pathloss-traces.cc
440<h3>Usage</h3>
441<code>$ ./ns3 run "lena-pathloss-traces [Program Options]"</code>
442
443<h3>Program Options</h3>
444<dl>
445 <dt>@c --enbDist </dt>
446 <dd>distance between the two eNBs [20] </dd>
447 <dt>@c --radius </dt>
448 <dd>the radius of the disc where UEs are placed around an eNB [10] </dd>
449 <dt>@c --numUes </dt>
450 <dd>how many UEs are attached to each eNB [1] </dd>
451</dl>
452*/
453/**
454 @file lena-profiling.cc
455<h3>Usage</h3>
456<code>$ ./ns3 run "lena-profiling [Program Options]"</code>
457
458<h3>Program Options</h3>
459<dl>
460 <dt>@c --nEnb </dt>
461 <dd>Number of eNodeBs per floor [1] </dd>
462 <dt>@c --nUe </dt>
463 <dd>Number of UEs [1] </dd>
464 <dt>@c --nFloors </dt>
465 <dd>Number of floors, 0 for Friis propagation model [0] </dd>
466 <dt>@c --simTime </dt>
467 <dd>Total duration of the simulation (in seconds) [1] </dd>
468</dl>
469*/
470/**
471 @file lena-radio-link-failure.cc
472<h3>Usage</h3>
473<code>$ ./ns3 run "lena-radio-link-failure [Program Options]"</code>
474
475<h3>Program Options</h3>
476<dl>
477 <dt>@c --simTime </dt>
478 <dd>Total duration of the simulation (in seconds) [+25s] </dd>
479 <dt>@c --numberOfEnbs </dt>
480 <dd>Number of eNBs [1] </dd>
481 <dt>@c --n311 </dt>
482 <dd>Number of in-synch indication [1] </dd>
483 <dt>@c --n310 </dt>
484 <dd>Number of out-of-synch indication [1] </dd>
485 <dt>@c --t310 </dt>
486 <dd>Timer for detecting the Radio link failure (in seconds) [+1s] </dd>
487 <dt>@c --interSiteDistance </dt>
488 <dd>Inter-site distance in meter [1200] </dd>
489 <dt>@c --useIdealRrc </dt>
490 <dd>Use ideal RRC protocol [true] </dd>
491 <dt>@c --enableCtrlErrorModel </dt>
492 <dd>Enable control error model [true] </dd>
493 <dt>@c --enableDataErrorModel </dt>
494 <dd>Enable data error model [true] </dd>
495 <dt>@c --enableNsLogs </dt>
496 <dd>Enable ns-3 logging (debug builds) [false] </dd>
497</dl>
498*/
499/**
500 @file lena-rem.cc
501<h3>Usage</h3>
502<code>$ ./ns3 run "lena-rem"</code>
503*/
504/**
505 @file lena-rem-sector-antenna.cc
506<h3>Usage</h3>
507<code>$ ./ns3 run "lena-rem-sector-antenna"</code>
508*/
509/**
510 @file lena-rlc-traces.cc
511<h3>Usage</h3>
512<code>$ ./ns3 run "lena-rlc-traces"</code>
513*/
514/**
515 @file lena-simple.cc
516<h3>Usage</h3>
517<code>$ ./ns3 run "lena-simple [Program Options]"</code>
518
519<h3>Program Options</h3>
520<dl>
521 <dt>@c --simTime </dt>
522 <dd>Total duration of the simulation [+1.05s] </dd>
523 <dt>@c --useCa </dt>
524 <dd>Whether to use carrier aggregation. [false] </dd>
525</dl>
526*/
527/**
528 @file lena-simple-epc.cc
529<h3>Usage</h3>
530<code>$ ./ns3 run "lena-simple-epc [Program Options]"</code>
531
532<h3>Program Options</h3>
533<dl>
534 <dt>@c --numNodePairs </dt>
535 <dd>Number of eNodeBs + UE pairs [2] </dd>
536 <dt>@c --simTime </dt>
537 <dd>Total duration of the simulation [+1.1s] </dd>
538 <dt>@c --distance </dt>
539 <dd>Distance between eNBs [m] [60] </dd>
540 <dt>@c --interPacketInterval </dt>
541 <dd>Inter packet interval [+100ms] </dd>
542 <dt>@c --useCa </dt>
543 <dd>Whether to use carrier aggregation. [false] </dd>
544 <dt>@c --disableDl </dt>
545 <dd>Disable downlink data flows [false] </dd>
546 <dt>@c --disableUl </dt>
547 <dd>Disable uplink data flows [false] </dd>
548 <dt>@c --disablePl </dt>
549 <dd>Disable data flows between peer UEs [false] </dd>
550</dl>
551*/
552/**
553 @file lena-x2-handover.cc
554<h3>Usage</h3>
555<code>$ ./ns3 run "lena-x2-handover [Program Options]"</code>
556
557<h3>Program Options</h3>
558<dl>
559 <dt>@c --numberOfUes </dt>
560 <dd>Number of UEs [1] </dd>
561 <dt>@c --numberOfEnbs </dt>
562 <dd>Number of eNodeBs [2] </dd>
563 <dt>@c --simTime </dt>
564 <dd>Total duration of the simulation [+490ms] </dd>
565 <dt>@c --disableDl </dt>
566 <dd>Disable downlink data flows [false] </dd>
567 <dt>@c --disableUl </dt>
568 <dd>Disable uplink data flows [false] </dd>
569</dl>
570*/
571/**
572 @file lr-wpan-data.cc
573<h3>Usage</h3>
574<code>$ ./ns3 run "lr-wpan-data [Program Options]"</code>
575
576<h3>Program Options</h3>
577<dl>
578 <dt>@c --verbose </dt>
579 <dd>turn on all log components [false] </dd>
580 <dt>@c --extended </dt>
581 <dd>use extended addressing [false] </dd>
582</dl>
583*/
584/**
585 @file lr-wpan-error-distance-plot.cc
586<h3>Usage</h3>
587<code>$ ./ns3 run "lr-wpan-error-distance-plot [Program Options]"</code>
588
589<h3>Program Options</h3>
590<dl>
591 <dt>@c --txPower </dt>
592 <dd>transmit power (dBm) [0] </dd>
593 <dt>@c --packetSize </dt>
594 <dd>packet (MSDU) size (bytes) [7] </dd>
595 <dt>@c --channelNumber </dt>
596 <dd>channel number [11] </dd>
597 <dt>@c --rxSensitivity </dt>
598 <dd>the rx sensitivity (dBm) [-106.58] </dd>
599</dl>
600*/
601/**
602 @file lr-wpan-phy-test.cc
603<h3>Usage</h3>
604<code>$ ./ns3 run "lr-wpan-phy-test"</code>
605*/
606/**
607 @file main-attribute-value.cc
608<h3>Usage</h3>
609<code>$ ./ns3 run "main-attribute-value [Program Options]"</code>
610
611<h3>Program Options</h3>
612<dl>
613 <dt>@c --maxSize </dt>
614 <dd>The max queue size (ns3::DropTailQueue<Packet>::MaxSize) [80p] </dd>
615</dl>
616*/
617/**
618 @file main-callback.cc
619<h3>Usage</h3>
620<code>$ ./ns3 run "main-callback"</code>
621*/
622/**
623 @file main-grid-topology.cc
624<h3>Usage</h3>
625<code>$ ./ns3 run "main-grid-topology"</code>
626*/
627/**
628 @file main-propagation-loss.cc
629<h3>Usage</h3>
630<code>$ ./ns3 run "main-propagation-loss [Program Options]"</code>
631
632<h3>Program Options</h3>
633<dl>
634 <dt>@c --test </dt>
635 <dd>Run as a test, sample the models only once [false] </dd>
636</dl>
637*/
638/**
639 @file main-ptr.cc
640<h3>Usage</h3>
641<code>$ ./ns3 run "main-ptr"</code>
642*/
643/**
644 @file main-random-topology.cc
645<h3>Usage</h3>
646<code>$ ./ns3 run "main-random-topology"</code>
647*/
648/**
649 @file main-random-walk.cc
650<h3>Usage</h3>
651<code>$ ./ns3 run "main-random-walk"</code>
652*/
653/**
654 @file main-simple.cc
655<h3>Usage</h3>
656<code>$ ./ns3 run "main-simple"</code>
657*/
658/**
659 @file mixed-global-routing.cc
660<h3>Usage</h3>
661<code>$ ./ns3 run "mixed-global-routing"</code>
662*/
663/**
664 @file mixed-wired-wireless.cc
665<h3>Usage</h3>
666<code>$ ./ns3 run "mixed-wired-wireless [Program Options]"</code>
667
668<h3>Program Options</h3>
669<dl>
670 <dt>@c --backboneNodes </dt>
671 <dd>number of backbone nodes [10] </dd>
672 <dt>@c --infraNodes </dt>
673 <dd>number of leaf nodes [2] </dd>
674 <dt>@c --lanNodes </dt>
675 <dd>number of LAN nodes [2] </dd>
676 <dt>@c --stopTime </dt>
677 <dd>simulation stop time (seconds) [20] </dd>
678 <dt>@c --useCourseChangeCallback </dt>
679 <dd>whether to enable course change tracing [false] </dd>
680</dl>
681*/
682/**
683 @file nix-simple.cc
684<h3>Usage</h3>
685<code>$ ./ns3 run "nix-simple [Program Options]"</code>
686
687<h3>Program Options</h3>
688<dl>
689 <dt>@c --useIPv6 </dt>
690 <dd>Use IPv6 instead of IPv4 [false] </dd>
691</dl>
692*/
693/**
694 @file object-names.cc
695<h3>Usage</h3>
696<code>$ ./ns3 run "object-names"</code>
697*/
698/**
699 @file outdoor-group-mobility-example.cc
700<h3>Usage</h3>
701<code>$ ./ns3 run "outdoor-group-mobility-example [Program Options]"</code>
702
703<h3>Program Options</h3>
704<dl>
705 <dt>@c --useHelper </dt>
706 <dd>Whether to use helper code [false] </dd>
707</dl>
708*/
709/**
710 @file pfifo-vs-red.cc
711<h3>Usage</h3>
712<code>$ ./ns3 run "pfifo-vs-red [Program Options]"</code>
713
714<h3>Program Options</h3>
715<dl>
716 <dt>@c --nLeaf </dt>
717 <dd>Number of left and right side leaf nodes [5] </dd>
718 <dt>@c --maxPackets </dt>
719 <dd>Max Packets allowed in the device queue [100] </dd>
720 <dt>@c --queueDiscLimitPackets </dt>
721 <dd>Max Packets allowed in the queue disc [1000] </dd>
722 <dt>@c --queueDiscType </dt>
723 <dd>Set QueueDisc type to PfifoFast or RED [PfifoFast] </dd>
724 <dt>@c --appPktSize </dt>
725 <dd>Set OnOff App Packet Size [512] </dd>
726 <dt>@c --appDataRate </dt>
727 <dd>Set OnOff App DataRate [10Mbps] </dd>
728 <dt>@c --modeBytes </dt>
729 <dd>Set QueueDisc mode to Packets &lt;0> or bytes &lt;1> [0] </dd>
730 <dt>@c --redMinTh </dt>
731 <dd>RED queue minimum threshold [50] </dd>
732 <dt>@c --redMaxTh </dt>
733 <dd>RED queue maximum threshold [80] </dd>
734</dl>
735*/
736/**
737 @file queue-discs-benchmark.cc
738<h3>Usage</h3>
739<code>$ ./ns3 run "queue-discs-benchmark [Program Options]"</code>
740
741<h3>Program Options</h3>
742<dl>
743 <dt>@c --bandwidth </dt>
744 <dd>Bottleneck bandwidth [10Mbps] </dd>
745 <dt>@c --delay </dt>
746 <dd>Bottleneck delay [5ms] </dd>
747 <dt>@c --queueDiscType </dt>
748 <dd>Bottleneck queue disc type in {PfifoFast, ARED, CoDel, FqCoDel, PIE, prio} [PfifoFast] </dd>
749 <dt>@c --queueDiscSize </dt>
750 <dd>Bottleneck queue disc size in packets [1000] </dd>
751 <dt>@c --netdevicesQueueSize </dt>
752 <dd>Bottleneck netdevices queue size in packets [50] </dd>
753 <dt>@c --bql </dt>
754 <dd>Enable byte queue limits on bottleneck netdevices [false] </dd>
755 <dt>@c --flowsDatarate </dt>
756 <dd>Upload and download flows datarate [20Mbps] </dd>
757 <dt>@c --flowsPacketsSize </dt>
758 <dd>Upload and download flows packets sizes [1000] </dd>
759 <dt>@c --startTime </dt>
760 <dd>Simulation start time [0.1] </dd>
761 <dt>@c --simDuration </dt>
762 <dd>Simulation duration in seconds [60] </dd>
763 <dt>@c --samplingPeriod </dt>
764 <dd>Goodput sampling period in seconds [1] </dd>
765</dl>
766*/
767/**
768 @file radvd-two-prefix.cc
769<h3>Usage</h3>
770<code>$ ./ns3 run "radvd-two-prefix [Program Options]"</code>
771
772<h3>Program Options</h3>
773<dl>
774 <dt>@c --verbose </dt>
775 <dd>turn on log components [false] </dd>
776</dl>
777*/
778/**
779 @file realtime-udp-echo.cc
780<h3>Usage</h3>
781<code>$ ./ns3 run "realtime-udp-echo"</code>
782*/
783/**
784 @file red-tests.cc
785<h3>Usage</h3>
786<code>$ ./ns3 run "red-tests [Program Options]"</code>
787
788<h3>Program Options</h3>
789<dl>
790 <dt>@c --testNumber </dt>
791 <dd>Run test 1, 3, 4 or 5 [1] </dd>
792 <dt>@c --pathOut </dt>
793 <dd>Path to save results from --writeForPlot/--writePcap/--writeFlowMonitor [.] </dd>
794 <dt>@c --writeForPlot </dt>
795 <dd>Write results for plot (gnuplot) [false] </dd>
796 <dt>@c --writePcap </dt>
797 <dd>Write results in pcapfile [false] </dd>
798 <dt>@c --writeFlowMonitor </dt>
799 <dd>Enable Flow Monitor and write their results [false] </dd>
800</dl>
801*/
802/**
803 @file red-vs-ared.cc
804<h3>Usage</h3>
805<code>$ ./ns3 run "red-vs-ared [Program Options]"</code>
806
807<h3>Program Options</h3>
808<dl>
809 <dt>@c --nLeaf </dt>
810 <dd>Number of left and right side leaf nodes [10] </dd>
811 <dt>@c --maxPackets </dt>
812 <dd>Max Packets allowed in the device queue [100] </dd>
813 <dt>@c --queueDiscLimitPackets </dt>
814 <dd>Max Packets allowed in the queue disc [1000] </dd>
815 <dt>@c --queueDiscType </dt>
816 <dd>Set Queue disc type to RED or ARED [RED] </dd>
817 <dt>@c --appPktSize </dt>
818 <dd>Set OnOff App Packet Size [512] </dd>
819 <dt>@c --appDataRate </dt>
820 <dd>Set OnOff App DataRate [10Mbps] </dd>
821 <dt>@c --modeBytes </dt>
822 <dd>Set Queue disc mode to Packets (false) or bytes (true) [false] </dd>
823 <dt>@c --redMinTh </dt>
824 <dd>RED queue minimum threshold [5] </dd>
825 <dt>@c --redMaxTh </dt>
826 <dd>RED queue maximum threshold [15] </dd>
827</dl>
828*/
829/**
830 @file red-vs-fengadaptive.cc
831<h3>Usage</h3>
832<code>$ ./ns3 run "red-vs-fengadaptive [Program Options]"</code>
833
834<h3>Program Options</h3>
835<dl>
836 <dt>@c --nLeaf </dt>
837 <dd>Number of left and right side leaf nodes [10] </dd>
838 <dt>@c --maxPackets </dt>
839 <dd>Max Packets allowed in the device queue [100] </dd>
840 <dt>@c --queueDiscLimitPackets </dt>
841 <dd>Max Packets allowed in the queue disc [1000] </dd>
842 <dt>@c --queueDiscType </dt>
843 <dd>Set Queue disc type to RED or FengAdaptive [RED] </dd>
844 <dt>@c --appPktSize </dt>
845 <dd>Set OnOff App Packet Size [512] </dd>
846 <dt>@c --appDataRate </dt>
847 <dd>Set OnOff App DataRate [10Mbps] </dd>
848 <dt>@c --modeBytes </dt>
849 <dd>Set Queue disc mode to Packets (false) or bytes (true) [false] </dd>
850 <dt>@c --redMinTh </dt>
851 <dd>RED queue minimum threshold [5] </dd>
852 <dt>@c --redMaxTh </dt>
853 <dd>RED queue maximum threshold [15] </dd>
854</dl>
855*/
856/**
857 @file red-vs-nlred.cc
858<h3>Usage</h3>
859<code>$ ./ns3 run "red-vs-nlred [Program Options]"</code>
860
861<h3>Program Options</h3>
862<dl>
863 <dt>@c --nLeaf </dt>
864 <dd>Number of left and right side leaf nodes [10] </dd>
865 <dt>@c --maxPackets </dt>
866 <dd>Max Packets allowed in the device queue [100] </dd>
867 <dt>@c --queueDiscLimitPackets </dt>
868 <dd>Max Packets allowed in the queue disc [1000] </dd>
869 <dt>@c --queueDiscType </dt>
870 <dd>Set Queue disc type to RED or NLRED [RED] </dd>
871 <dt>@c --appPktSize </dt>
872 <dd>Set OnOff App Packet Size [512] </dd>
873 <dt>@c --appDataRate </dt>
874 <dd>Set OnOff App DataRate [10Mbps] </dd>
875 <dt>@c --modeBytes </dt>
876 <dd>Set Queue disc mode to Packets (false) or bytes (true) [false] </dd>
877 <dt>@c --redMinTh </dt>
878 <dd>RED queue minimum threshold [5] </dd>
879 <dt>@c --redMaxTh </dt>
880 <dd>RED queue maximum threshold [15] </dd>
881</dl>
882*/
883/**
884 @file reference-point-group-mobility-example.cc
885<h3>Usage</h3>
886<code>$ ./ns3 run "reference-point-group-mobility-example [Program Options]"</code>
887
888<h3>Program Options</h3>
889<dl>
890 <dt>@c --useHelper </dt>
891 <dd>Whether to use helper code [false] </dd>
892</dl>
893*/
894/**
895 @file rv-battery-model-test.cc
896<h3>Usage</h3>
897<code>$ ./ns3 run "rv-battery-model-test"</code>
898*/
899/**
900 @file sample-random-variable.cc
901<h3>Usage</h3>
902<code>$ ./ns3 run "sample-random-variable"</code>
903*/
904/**
905 @file sample-simulator.cc
906<h3>Usage</h3>
907<code>$ ./ns3 run "sample-simulator"</code>
908*/
909/**
910 @file second.cc
911<h3>Usage</h3>
912<code>$ ./ns3 run "second [Program Options]"</code>
913
914<h3>Program Options</h3>
915<dl>
916 <dt>@c --nCsma </dt>
917 <dd>Number of &quot;extra&quot; CSMA nodes/devices [3] </dd>
918 <dt>@c --verbose </dt>
919 <dd>Tell echo applications to log if true [true] </dd>
920</dl>
921*/
922/**
923 @file seventh.cc
924<h3>Usage</h3>
925<code>$ ./ns3 run "seventh [Program Options]"</code>
926
927<h3>Program Options</h3>
928<dl>
929 <dt>@c --useIpv6 </dt>
930 <dd>Use Ipv6 [false] </dd>
931</dl>
932*/
933/**
934 @file simple-alternate-routing.cc
935<h3>Usage</h3>
936<code>$ ./ns3 run "simple-alternate-routing [Program Options]"</code>
937
938<h3>Program Options</h3>
939<dl>
940 <dt>@c --AlternateCost </dt>
941 <dd>This metric is used in the example script between n3 and n1 [1] </dd>
942</dl>
943*/
944/**
945 @file simple-error-model.cc
946<h3>Usage</h3>
947<code>$ ./ns3 run "simple-error-model [Program Options]"</code>
948
949<h3>Program Options</h3>
950<dl>
951 <dt>@c --errorModelType </dt>
952 <dd>TypeId of the error model to use [ns3::RateErrorModel] </dd>
953</dl>
954*/
955/**
956 @file simple-global-routing.cc
957<h3>Usage</h3>
958<code>$ ./ns3 run "simple-global-routing [Program Options]"</code>
959
960<h3>Program Options</h3>
961<dl>
962 <dt>@c --EnableMonitor </dt>
963 <dd>Enable Flow Monitor [false] </dd>
964</dl>
965*/
966/**
967 @file simple-point-to-point-olsr.cc
968<h3>Usage</h3>
969<code>$ ./ns3 run "simple-point-to-point-olsr"</code>
970*/
971/**
972 @file simple-routing-ping6.cc
973<h3>Usage</h3>
974<code>$ ./ns3 run "simple-routing-ping6"</code>
975*/
976/**
977 @file sixth.cc
978<h3>Usage</h3>
979<code>$ ./ns3 run "sixth"</code>
980*/
981/**
982 @file star-animation.cc
983<h3>Usage</h3>
984<code>$ ./ns3 run "star-animation [Program Options]"</code>
985
986<h3>Program Options</h3>
987<dl>
988 <dt>@c --nSpokes </dt>
989 <dd>Number of spoke nodes to place in the star [8] </dd>
990 <dt>@c --animFile </dt>
991 <dd>File Name for Animation Output [star-animation.xml] </dd>
992 <dt>@c --useIpv6 </dt>
993 <dd>use Ipv6 [ ] </dd>
994</dl>
995*/
996/**
997 @file star.cc
998<h3>Usage</h3>
999<code>$ ./ns3 run "star [Program Options]"</code>
1000
1001<h3>Program Options</h3>
1002<dl>
1003 <dt>@c --nSpokes </dt>
1004 <dd>Number of nodes to place in the star [8] </dd>
1005</dl>
1006*/
1007/**
1008 @file static-routing-slash32.cc
1009<h3>Usage</h3>
1010<code>$ ./ns3 run "static-routing-slash32"</code>
1011*/
1012/**
1013 @file system-path-examples.cc
1014<h3>Usage</h3>
1015<code>$ ./ns3 run "system-path-examples [Program Options]"</code>
1016SystemPath examples.
1017
1018
1019<h3>Program Options</h3>
1020<dl>
1021 <dt>@c --path </dt>
1022 <dd>Path to demonstrate SystemPath functions. [/tmp/nsnam/update-docs/ns-3-dev/build/src/core/examples] </dd>
1023</dl>
1024*/
1025/**
1026 @file tcp-ecn-example.cc
1027<h3>Usage</h3>
1028<code>$ ./ns3 run "tcp-ecn-example [Program Options]"</code>
1029
1030<h3>Program Options</h3>
1031<dl>
1032 <dt>@c --tcpTypeId </dt>
1033 <dd>Transport protocol to use: TcpNewReno,TcpCubic, TcpLinuxReno [TcpCubic] </dd>
1034 <dt>@c --delAckCount </dt>
1035 <dd>Delayed ACK count [2] </dd>
1036 <dt>@c --enablePcap </dt>
1037 <dd>Enable/Disable pcap file generation [false] </dd>
1038 <dt>@c --useEcn </dt>
1039 <dd>Enable/Disable ECN [true] </dd>
1040 <dt>@c --useAbe </dt>
1041 <dd>Enable/Disable ABE [false] </dd>
1042 <dt>@c --stopTime </dt>
1043 <dd>Stop time for applications / simulation time will be stopTime + 1 [+1.66667min] </dd>
1044</dl>
1045*/
1046/**
1047 @file tcp-large-transfer.cc
1048<h3>Usage</h3>
1049<code>$ ./ns3 run "tcp-large-transfer"</code>
1050*/
1051/**
1052 @file tcp-star-server.cc
1053<h3>Usage</h3>
1054<code>$ ./ns3 run "tcp-star-server [Program Options]"</code>
1055
1056<h3>Program Options</h3>
1057<dl>
1058 <dt>@c --nNodes </dt>
1059 <dd>Number of nodes to place in the star [9] </dd>
1060</dl>
1061*/
1062/**
1063 @file tcp-validation.cc
1064<h3>Usage</h3>
1065<code>$ ./ns3 run "tcp-validation [Program Options]"</code>
1066
1067<h3>Program Options</h3>
1068<dl>
1069 <dt>@c --firstTcpType </dt>
1070 <dd>first TCP type (cubic, dctcp, or reno) [cubic] </dd>
1071 <dt>@c --secondTcpType </dt>
1072 <dd>second TCP type (cubic, dctcp, or reno) </dd>
1073 <dt>@c --queueType </dt>
1074 <dd>bottleneck queue type (fq, codel, pie, or red) [codel] </dd>
1075 <dt>@c --baseRtt </dt>
1076 <dd>base RTT [+80ms] </dd>
1077 <dt>@c --ceThreshold </dt>
1078 <dd>CoDel CE threshold (for DCTCP) [+1ms] </dd>
1079 <dt>@c --linkRate </dt>
1080 <dd>data rate of bottleneck link [50000000bps] </dd>
1081 <dt>@c --stopTime </dt>
1082 <dd>simulation stop time [+1.16667min] </dd>
1083 <dt>@c --queueUseEcn </dt>
1084 <dd>use ECN on queue [false] </dd>
1085 <dt>@c --enablePcap </dt>
1086 <dd>enable Pcap [false] </dd>
1087 <dt>@c --validate </dt>
1088 <dd>validation case to run </dd>
1089</dl>
1090*/
1091/**
1092 @file tcp-variants-comparison.cc
1093<h3>Usage</h3>
1094<code>$ ./ns3 run "tcp-variants-comparison [Program Options]"</code>
1095
1096<h3>Program Options</h3>
1097<dl>
1098 <dt>@c --transport_prot </dt>
1099 <dd>Transport protocol to use: TcpNewReno, TcpLinuxReno, TcpHybla, TcpHighSpeed, TcpHtcp, TcpVegas, TcpScalable, TcpVeno, TcpBic, TcpYeah, TcpIllinois, TcpWestwoodPlus, TcpLedbat, TcpLp, TcpDctcp, TcpCubic, TcpBbr [TcpWestwoodPlus] </dd>
1100 <dt>@c --error_p </dt>
1101 <dd>Packet error rate [0] </dd>
1102 <dt>@c --bandwidth </dt>
1103 <dd>Bottleneck bandwidth [2Mbps] </dd>
1104 <dt>@c --delay </dt>
1105 <dd>Bottleneck delay [0.01ms] </dd>
1106 <dt>@c --access_bandwidth </dt>
1107 <dd>Access link bandwidth [10Mbps] </dd>
1108 <dt>@c --access_delay </dt>
1109 <dd>Access link delay [45ms] </dd>
1110 <dt>@c --tracing </dt>
1111 <dd>Flag to enable/disable tracing [false] </dd>
1112 <dt>@c --prefix_name </dt>
1113 <dd>Prefix of output trace file [TcpVariantsComparison] </dd>
1114 <dt>@c --data </dt>
1115 <dd>Number of Megabytes of data to transmit [0] </dd>
1116 <dt>@c --mtu </dt>
1117 <dd>Size of IP packets to send in bytes [400] </dd>
1118 <dt>@c --num_flows </dt>
1119 <dd>Number of flows [1] </dd>
1120 <dt>@c --duration </dt>
1121 <dd>Time to allow flows to run in seconds [100] </dd>
1122 <dt>@c --run </dt>
1123 <dd>Run index (for setting repeatable seeds) [0] </dd>
1124 <dt>@c --flow_monitor </dt>
1125 <dd>Enable flow monitor [false] </dd>
1126 <dt>@c --pcap_tracing </dt>
1127 <dd>Enable or disable PCAP tracing [false] </dd>
1128 <dt>@c --queue_disc_type </dt>
1129 <dd>Queue disc type for gateway (e.g. ns3::CoDelQueueDisc) [ns3::PfifoFastQueueDisc] </dd>
1130 <dt>@c --sack </dt>
1131 <dd>Enable or disable SACK option [true] </dd>
1132 <dt>@c --recovery </dt>
1133 <dd>Recovery algorithm type to use (e.g., ns3::TcpPrrRecovery [ns3::TcpClassicRecovery] </dd>
1134</dl>
1135*/
1136/**
1137 @file third.cc
1138<h3>Usage</h3>
1139<code>$ ./ns3 run "third [Program Options]"</code>
1140
1141<h3>Program Options</h3>
1142<dl>
1143 <dt>@c --nCsma </dt>
1144 <dd>Number of &quot;extra&quot; CSMA nodes/devices [3] </dd>
1145 <dt>@c --nWifi </dt>
1146 <dd>Number of wifi STA devices [3] </dd>
1147 <dt>@c --verbose </dt>
1148 <dd>Tell echo applications to log if true [true] </dd>
1149 <dt>@c --tracing </dt>
1150 <dd>Enable pcap tracing [false] </dd>
1151</dl>
1152*/
1153/**
1154 @file three-gpp-v2v-channel-example.cc
1155<h3>Usage</h3>
1156<code>$ ./ns3 run "three-gpp-v2v-channel-example [Program Options]"</code>
1157
1158<h3>Program Options</h3>
1159<dl>
1160 <dt>@c --frequency </dt>
1161 <dd>operating frequency in Hz [2.8e+10] </dd>
1162 <dt>@c --txPow </dt>
1163 <dd>tx power in dBm [30] </dd>
1164 <dt>@c --noiseFigure </dt>
1165 <dd>noise figure in dB [9] </dd>
1166 <dt>@c --scenario </dt>
1167 <dd>3GPP propagation scenario, V2V-Urban or V2V-Highway [V2V-Urban] </dd>
1168</dl>
1169*/
1170/**
1171 @file uan-cw-example.cc
1172<h3>Usage</h3>
1173<code>$ ./ns3 run "uan-cw-example [Program Options]"</code>
1174
1175<h3>Program Options</h3>
1176<dl>
1177 <dt>@c --NumNodes </dt>
1178 <dd>Number of transmitting nodes [15] </dd>
1179 <dt>@c --Depth </dt>
1180 <dd>Depth of transmitting and sink nodes [70] </dd>
1181 <dt>@c --RegionSize </dt>
1182 <dd>Size of boundary in meters [500] </dd>
1183 <dt>@c --PacketSize </dt>
1184 <dd>Generated packet size in bytes [32] </dd>
1185 <dt>@c --DataRate </dt>
1186 <dd>DataRate in bps [80] </dd>
1187 <dt>@c --CwMin </dt>
1188 <dd>Min CW to simulate [10] </dd>
1189 <dt>@c --CwMax </dt>
1190 <dd>Max CW to simulate [400] </dd>
1191 <dt>@c --SlotTime </dt>
1192 <dd>Slot time duration [+200ms] </dd>
1193 <dt>@c --Averages </dt>
1194 <dd>Number of topologies to test for each cw point [3] </dd>
1195 <dt>@c --GnuFile </dt>
1196 <dd>Name for GNU Plot output [uan-cw-example.gpl] </dd>
1197 <dt>@c --PerModel </dt>
1198 <dd>PER model name [ns3::UanPhyPerGenDefault] </dd>
1199 <dt>@c --SinrModel </dt>
1200 <dd>SINR model name [ns3::UanPhyCalcSinrDefault] </dd>
1201 <dt>@c --Quiet </dt>
1202 <dd>Run in quiet mode (disable logging) [false] </dd>
1203</dl>
1204*/
1205/**
1206 @file uan-rc-example.cc
1207<h3>Usage</h3>
1208<code>$ ./ns3 run "uan-rc-example [Program Options]"</code>
1209
1210<h3>Program Options</h3>
1211<dl>
1212 <dt>@c --TotalRate </dt>
1213 <dd>Total channel capacity [4096] </dd>
1214 <dt>@c --NumberRates </dt>
1215 <dd>Number of divided rates ( (NumberRates+1)%TotalRate should be 0) [1023] </dd>
1216 <dt>@c --MaxRange </dt>
1217 <dd>Maximum range between gateway and acoustic node [3000] </dd>
1218 <dt>@c --SimMin </dt>
1219 <dd>Minimum parameter to test (nodes if DoNode=1, &quot;a&quot; param otherwise) [1] </dd>
1220 <dt>@c --SimMax </dt>
1221 <dd>Maximum parameter to test (nodes if DoNode=1, &quot;a&quot; param otherwise) [1] </dd>
1222 <dt>@c --SimStep </dt>
1223 <dd>Amount to increment param per trial [1] </dd>
1224 <dt>@c --DataFile </dt>
1225 <dd>Filename for GnuPlot [uan-rc-example.gpl] </dd>
1226 <dt>@c --NumberNodes </dt>
1227 <dd>Number of nodes (invalid for doNode=1) [15] </dd>
1228 <dt>@c --SIFS </dt>
1229 <dd>SIFS time duration [+50ms] </dd>
1230 <dt>@c --PktSize </dt>
1231 <dd>Packet size in bytes [1000] </dd>
1232 <dt>@c --SimTime </dt>
1233 <dd>Simulation time per trial [+1.38889h] </dd>
1234 <dt>@c --DoNode </dt>
1235 <dd>1 for do max nodes simulation (invalidates AMin and AMax values) [true] </dd>
1236 <dt>@c --Quiet </dt>
1237 <dd>Run in quiet mode (disable logging) [false] </dd>
1238</dl>
1239*/
1240/**
1241 @file udp-echo.cc
1242<h3>Usage</h3>
1243<code>$ ./ns3 run "udp-echo [Program Options]"</code>
1244
1245<h3>Program Options</h3>
1246<dl>
1247 <dt>@c --useIpv6 </dt>
1248 <dd>Use Ipv6 [false] </dd>
1249</dl>
1250*/
1251/**
1252 @file wifi-80211e-txop.cc
1253<h3>Usage</h3>
1254<code>$ ./ns3 run "wifi-80211e-txop [Program Options]"</code>
1255
1256<h3>Program Options</h3>
1257<dl>
1258 <dt>@c --payloadSize </dt>
1259 <dd>Payload size in bytes [1472] </dd>
1260 <dt>@c --simulationTime </dt>
1261 <dd>Simulation time [+10s] </dd>
1262 <dt>@c --distance </dt>
1263 <dd>Distance in meters between the station and the access point [5] </dd>
1264 <dt>@c --enablePcap </dt>
1265 <dd>Enable/disable pcap file generation [false] </dd>
1266 <dt>@c --verifyResults </dt>
1267 <dd>Enable/disable results verification at the end of the simulation [false] </dd>
1268</dl>
1269*/
1270/**
1271 @file wifi-80211n-mimo.cc
1272<h3>Usage</h3>
1273<code>$ ./ns3 run "wifi-80211n-mimo [Program Options]"</code>
1274
1275<h3>Program Options</h3>
1276<dl>
1277 <dt>@c --step </dt>
1278 <dd>Granularity of the results to be plotted in meters [5] </dd>
1279 <dt>@c --simulationTime </dt>
1280 <dd>Simulation time per step [+5s] </dd>
1281 <dt>@c --channelBonding </dt>
1282 <dd>Enable/disable channel bonding (channel width = 20 MHz if false, channel width = 40 MHz if true) [false] </dd>
1283 <dt>@c --preambleDetection </dt>
1284 <dd>Enable/disable preamble detection model [true] </dd>
1285 <dt>@c --shortGuardInterval </dt>
1286 <dd>Enable/disable short guard interval [false] </dd>
1287 <dt>@c --frequency </dt>
1288 <dd>Whether working in the 2.4 or 5.0 GHz band (other values gets rejected) [5] </dd>
1289 <dt>@c --udp </dt>
1290 <dd>UDP if set to 1, TCP otherwise [true] </dd>
1291</dl>
1292*/
1293/**
1294 @file wifi-aggregation.cc
1295<h3>Usage</h3>
1296<code>$ ./ns3 run "wifi-aggregation [Program Options]"</code>
1297
1298<h3>Program Options</h3>
1299<dl>
1300 <dt>@c --payloadSize </dt>
1301 <dd>Payload size in bytes [1472] </dd>
1302 <dt>@c --enableRts </dt>
1303 <dd>Enable or disable RTS/CTS [false] </dd>
1304 <dt>@c --simulationTime </dt>
1305 <dd>Simulation time [+10s] </dd>
1306 <dt>@c --distance </dt>
1307 <dd>Distance in meters between the station and the access point [5] </dd>
1308 <dt>@c --enablePcap </dt>
1309 <dd>Enable/disable pcap file generation [false] </dd>
1310 <dt>@c --verifyResults </dt>
1311 <dd>Enable/disable results verification at the end of the simulation [false] </dd>
1312</dl>
1313*/
1314/**
1315 @file wifi-ap.cc
1316<h3>Usage</h3>
1317<code>$ ./ns3 run "wifi-ap [Program Options]"</code>
1318
1319<h3>Program Options</h3>
1320<dl>
1321 <dt>@c --verbose </dt>
1322 <dd>Print trace information if true [true] </dd>
1323</dl>
1324*/
1325/**
1326 @file wifi-backward-compatibility.cc
1327<h3>Usage</h3>
1328<code>$ ./ns3 run "wifi-backward-compatibility [Program Options]"</code>
1329
1330<h3>Program Options</h3>
1331<dl>
1332 <dt>@c --simulationTime </dt>
1333 <dd>Simulation time [+10s] </dd>
1334 <dt>@c --apVersion </dt>
1335 <dd>The standard version used by the AP: 80211a, 80211b, 80211g, 80211p, 80211n_2_4GHZ, 80211n_5GHZ, 80211ac, 80211ax_2_4GHZ or 80211ax_5GHZ [80211a] </dd>
1336 <dt>@c --staVersion </dt>
1337 <dd>The standard version used by the station: 80211a, 80211b, 80211g, 80211_10MHZ, 80211_5MHZ, 80211n_2_4GHZ, 80211n_5GHZ, 80211ac, 80211ax_2_4GHZ or 80211ax_5GHZ [80211n_5GHZ] </dd>
1338 <dt>@c --apRaa </dt>
1339 <dd>Rate adaptation algorithm used by the AP [Minstrel] </dd>
1340 <dt>@c --staRaa </dt>
1341 <dd>Rate adaptation algorithm used by the station [MinstrelHt] </dd>
1342 <dt>@c --apHasTraffic </dt>
1343 <dd>Enable/disable traffic on the AP [false] </dd>
1344 <dt>@c --staHasTraffic </dt>
1345 <dd>Enable/disable traffic on the station [true] </dd>
1346</dl>
1347*/
1348/**
1349 @file wifi-bianchi.cc
1350<h3>Usage</h3>
1351<code>$ ./ns3 run "wifi-bianchi [Program Options]"</code>
1352
1353<h3>Program Options</h3>
1354<dl>
1355 <dt>@c --verbose </dt>
1356 <dd>Logging level (0: no log - 1: simulation script logs - 2: all logs) [0] </dd>
1357 <dt>@c --tracing </dt>
1358 <dd>Generate trace files [false] </dd>
1359 <dt>@c --useTxHelper </dt>
1360 <dd>Enable WifiTxStatsHelper on all devices [false] </dd>
1361 <dt>@c --useRxHelper </dt>
1362 <dd>Enable WifiPhyRxTraceHelper on all devices [false] </dd>
1363 <dt>@c --pktSize </dt>
1364 <dd>The packet size in bytes [1500] </dd>
1365 <dt>@c --trials </dt>
1366 <dd>The maximal number of runs per network size [1] </dd>
1367 <dt>@c --duration </dt>
1368 <dd>Time duration for each trial in seconds [100] </dd>
1369 <dt>@c --pcap </dt>
1370 <dd>Enable/disable PCAP tracing [false] </dd>
1371 <dt>@c --infra </dt>
1372 <dd>True to use infrastructure mode, false to use ring adhoc mode [false] </dd>
1373 <dt>@c --workDir </dt>
1374 <dd>The working directory used to store generated files [./] </dd>
1375 <dt>@c --phyMode </dt>
1376 <dd>Set the constant PHY mode string used to transmit frames [OfdmRate54Mbps] </dd>
1377 <dt>@c --standard </dt>
1378 <dd>Set the standard (11a, 11b, 11g, 11n, 11ac, 11ax) [11a] </dd>
1379 <dt>@c --nMinStas </dt>
1380 <dd>Minimum number of stations to start with [5] </dd>
1381 <dt>@c --nMaxStas </dt>
1382 <dd>Maximum number of stations to start with [50] </dd>
1383 <dt>@c --nStepSize </dt>
1384 <dd>Number of stations to add at each step [5] </dd>
1385 <dt>@c --plotBianchiModel </dt>
1386 <dd>First bit corresponds to the DIFS model, second bit to the EIFS model [1] </dd>
1387 <dt>@c --validate </dt>
1388 <dd>Enable/disable validation of the ns-3 simulations against the Bianchi model [false] </dd>
1389 <dt>@c --maxRelativeError </dt>
1390 <dd>The maximum relative error tolerated between ns-3 results and the Bianchi model (used for regression, i.e. when the validate flag is set) [0.015] </dd>
1391 <dt>@c --frequency </dt>
1392 <dd>Set the operating frequency band in GHz: 2.4, 5 or 6 [5] </dd>
1393 <dt>@c --channelWidth </dt>
1394 <dd>Set the constant channel width in MHz (only for 11n/ac/ax) [20] </dd>
1395 <dt>@c --guardIntervalNs </dt>
1396 <dd>Set the the guard interval in nanoseconds (800 or 400 for 11n/ac, 800 or 1600 or 3200 for 11 ax) [800] </dd>
1397 <dt>@c --maxMpdus </dt>
1398 <dd>Set the maximum number of MPDUs in A-MPDUs (0 to disable MPDU aggregation) [ ] </dd>
1399 <dt>@c --distance </dt>
1400 <dd>Set the distance in meters between the AP and the STAs [0.001] </dd>
1401 <dt>@c --apTxPower </dt>
1402 <dd>Set the transmit power of the AP in dBm (if infrastructure only) [16] </dd>
1403 <dt>@c --staTxPower </dt>
1404 <dd>Set the transmit power of each STA in dBm (or all STAs if adhoc) [16] </dd>
1405 <dt>@c --pktInterval </dt>
1406 <dd>Set the socket packet interval in microseconds [1000] </dd>
1407</dl>
1408*/
1409/**
1410 @file wifi-blockack.cc
1411<h3>Usage</h3>
1412<code>$ ./ns3 run "wifi-blockack"</code>
1413*/
1414/**
1415 @file wifi-dsss-validation.cc
1416<h3>Usage</h3>
1417<code>$ ./ns3 run "wifi-dsss-validation [Program Options]"</code>
1418
1419<h3>Program Options</h3>
1420<dl>
1421 <dt>@c --FrameSize </dt>
1422 <dd>The frame size in bytes [1500] </dd>
1423</dl>
1424*/
1425/**
1426 @file wifi-eht-network.cc
1427<h3>Usage</h3>
1428<code>$ ./ns3 run "wifi-eht-network [Program Options]"</code>
1429
1430<h3>Program Options</h3>
1431<dl>
1432 <dt>@c --staticSetup </dt>
1433 <dd>Whether devices are configured using the static setup helper [true] </dd>
1434 <dt>@c --frequency </dt>
1435 <dd>Whether the first link operates in the 2.4, 5 or 6 GHz band (other values gets rejected) [5] </dd>
1436 <dt>@c --frequency2 </dt>
1437 <dd>Whether the second link operates in the 2.4, 5 or 6 GHz band (0 means the device has one link, otherwise the band must be different than first link and third link) [0] </dd>
1438 <dt>@c --frequency3 </dt>
1439 <dd>Whether the third link operates in the 2.4, 5 or 6 GHz band (0 means the device has up to two links, otherwise the band must be different than first link and second link) [0] </dd>
1440 <dt>@c --emlsrMgrTypeId </dt>
1441 <dd>The ns-3 TypeId of the EMLSR manager to use [ns3::DefaultEmlsrManager] </dd>
1442 <dt>@c --emlsrLinks </dt>
1443 <dd>The comma separated list of IDs of EMLSR links (for MLDs only) </dd>
1444 <dt>@c --emlsrPaddingDelay </dt>
1445 <dd>The EMLSR padding delay in microseconds (0, 32, 64, 128 or 256) [32] </dd>
1446 <dt>@c --emlsrTransitionDelay </dt>
1447 <dd>The EMLSR transition delay in microseconds (0, 16, 32, 64, 128 or 256) [128] </dd>
1448 <dt>@c --emlsrAuxSwitch </dt>
1449 <dd>Whether Aux PHY should switch channel to operate on the link on which the Main PHY was operating before moving to the link of the Aux PHY. [true] </dd>
1450 <dt>@c --emlsrAuxChWidth </dt>
1451 <dd>The maximum channel width (MHz) supported by Aux PHYs. [20] </dd>
1452 <dt>@c --emlsrAuxTxCapable </dt>
1453 <dd>Whether Aux PHYs are capable of transmitting. [true] </dd>
1454 <dt>@c --channelSwitchDelay </dt>
1455 <dd>The PHY channel switch delay [+100us] </dd>
1456 <dt>@c --distance </dt>
1457 <dd>Distance in meters between the station and the access point [1] </dd>
1458 <dt>@c --simulationTime </dt>
1459 <dd>Simulation time [+10s] </dd>
1460 <dt>@c --udp </dt>
1461 <dd>UDP if set to 1, TCP otherwise [true] </dd>
1462 <dt>@c --downlink </dt>
1463 <dd>Generate downlink flows if set to 1, uplink flows otherwise [true] </dd>
1464 <dt>@c --useRts </dt>
1465 <dd>Enable/disable RTS/CTS [false] </dd>
1466 <dt>@c --use80Plus80 </dt>
1467 <dd>Enable/disable use of 80+80 MHz [false] </dd>
1468 <dt>@c --mpduBufferSize </dt>
1469 <dd>Size (in number of MPDUs) of the BlockAck buffer [512] </dd>
1470 <dt>@c --nStations </dt>
1471 <dd>Number of non-AP EHT stations [1] </dd>
1472 <dt>@c --dlAckType </dt>
1473 <dd>Ack sequence type for DL OFDMA (NO-OFDMA, ACK-SU-FORMAT, MU-BAR, AGGR-MU-BAR) [NO-OFDMA] </dd>
1474 <dt>@c --enableUlOfdma </dt>
1475 <dd>Enable UL OFDMA (useful if DL OFDMA is enabled and TCP is used) [false] </dd>
1476 <dt>@c --enableBsrp </dt>
1477 <dd>Enable BSRP (useful if DL and UL OFDMA are enabled and TCP is used) [false] </dd>
1478 <dt>@c --muSchedAccessReqInterval </dt>
1479 <dd>Duration of the interval between two requests for channel access made by the MU scheduler [+0fs] </dd>
1480 <dt>@c --mcs </dt>
1481 <dd>list of comma separated MCS values to test; if unset, all MCS values (0-13) are tested </dd>
1482 <dt>@c --channelWidth </dt>
1483 <dd>if set, limit testing to a specific channel width expressed in MHz (20, 40, 80, 160 or 320 MHz) [-1] </dd>
1484 <dt>@c --guardInterval </dt>
1485 <dd>if set, limit testing to a specific guard interval duration expressed in nanoseconds (800, 1600 or 3200 ns) [-1] </dd>
1486 <dt>@c --payloadSize </dt>
1487 <dd>The application payload size in bytes [700] </dd>
1488 <dt>@c --tputInterval </dt>
1489 <dd>duration of intervals for throughput measurement [+0fs] </dd>
1490 <dt>@c --minExpectedThroughput </dt>
1491 <dd>if set, simulation fails if the lowest throughput is below this value [0] </dd>
1492 <dt>@c --maxExpectedThroughput </dt>
1493 <dd>if set, simulation fails if the highest throughput is above this value [0] </dd>
1494</dl>
1495*/
1496/**
1497 @file wifi-error-models-comparison.cc
1498<h3>Usage</h3>
1499<code>$ ./ns3 run "wifi-error-models-comparison [Program Options]"</code>
1500
1501<h3>Program Options</h3>
1502<dl>
1503 <dt>@c --size </dt>
1504 <dd>The size in bits [12000] </dd>
1505 <dt>@c --frameFormat </dt>
1506 <dd>The frame format to use: Ht, Vht or He [Ht] </dd>
1507 <dt>@c --beginMcs </dt>
1508 <dd>The first MCS to test [ ] </dd>
1509 <dt>@c --endMcs </dt>
1510 <dd>The last MCS to test [␇] </dd>
1511 <dt>@c --stepMcs </dt>
1512 <dd>The step between two MCSs to test [␄] </dd>
1513 <dt>@c --includeTableErrorModel </dt>
1514 <dd>Flag to include/exclude Table-based error model [true] </dd>
1515 <dt>@c --includeYansErrorModel </dt>
1516 <dd>Flag to include/exclude Yans error model [true] </dd>
1517 <dt>@c --includeNistErrorModel </dt>
1518 <dd>Flag to include/exclude Nist error model [true] </dd>
1519</dl>
1520*/
1521/**
1522 @file wifi-example-sim.cc
1523<h3>Usage</h3>
1524<code>$ ./ns3 run "wifi-example-sim [Program Options]"</code>
1525
1526<h3>Program Options</h3>
1527<dl>
1528 <dt>@c --distance </dt>
1529 <dd>Distance apart to place nodes (in meters). [50] </dd>
1530 <dt>@c --format </dt>
1531 <dd>Format to use for data output. [omnet] </dd>
1532 <dt>@c --experiment </dt>
1533 <dd>Identifier for experiment. [wifi-distance-test] </dd>
1534 <dt>@c --strategy </dt>
1535 <dd>Identifier for strategy. [wifi-default] </dd>
1536 <dt>@c --run </dt>
1537 <dd>Identifier for run. [run-1769469624] </dd>
1538</dl>
1539*/
1540/**
1541 @file wifi-he-network.cc
1542<h3>Usage</h3>
1543<code>$ ./ns3 run "wifi-he-network [Program Options]"</code>
1544
1545<h3>Program Options</h3>
1546<dl>
1547 <dt>@c --staticSetup </dt>
1548 <dd>Whether devices are configured using the static setup helper [true] </dd>
1549 <dt>@c --frequency </dt>
1550 <dd>Whether working in the 2.4, 5 or 6 GHz band (other values gets rejected) [5] </dd>
1551 <dt>@c --distance </dt>
1552 <dd>Distance in meters between the station and the access point [1] </dd>
1553 <dt>@c --simulationTime </dt>
1554 <dd>Simulation time [+10s] </dd>
1555 <dt>@c --udp </dt>
1556 <dd>UDP if set to 1, TCP otherwise [true] </dd>
1557 <dt>@c --downlink </dt>
1558 <dd>Generate downlink flows if set to 1, uplink flows otherwise [true] </dd>
1559 <dt>@c --useRts </dt>
1560 <dd>Enable/disable RTS/CTS [false] </dd>
1561 <dt>@c --use80Plus80 </dt>
1562 <dd>Enable/disable use of 80+80 MHz [false] </dd>
1563 <dt>@c --useExtendedBlockAck </dt>
1564 <dd>Enable/disable use of extended BACK [false] </dd>
1565 <dt>@c --nStations </dt>
1566 <dd>Number of non-AP HE stations [1] </dd>
1567 <dt>@c --dlAckType </dt>
1568 <dd>Ack sequence type for DL OFDMA (NO-OFDMA, ACK-SU-FORMAT, MU-BAR, AGGR-MU-BAR) [NO-OFDMA] </dd>
1569 <dt>@c --enableUlOfdma </dt>
1570 <dd>Enable UL OFDMA (useful if DL OFDMA is enabled and TCP is used) [false] </dd>
1571 <dt>@c --enableBsrp </dt>
1572 <dd>Enable BSRP (useful if DL and UL OFDMA are enabled and TCP is used) [false] </dd>
1573 <dt>@c --muSchedAccessReqInterval </dt>
1574 <dd>Duration of the interval between two requests for channel access made by the MU scheduler [+0fs] </dd>
1575 <dt>@c --mcs </dt>
1576 <dd>list of comma separated MCS values to test; if unset, all MCS values (0-11) are tested </dd>
1577 <dt>@c --channelWidth </dt>
1578 <dd>if set, limit testing to a specific channel width expressed in MHz (20, 40, 80 or 160 MHz) [-1] </dd>
1579 <dt>@c --guardInterval </dt>
1580 <dd>if set, limit testing to a specific guard interval duration expressed in nanoseconds (800, 1600 or 3200 ns) [-1] </dd>
1581 <dt>@c --payloadSize </dt>
1582 <dd>The application payload size in bytes [700] </dd>
1583 <dt>@c --phyModel </dt>
1584 <dd>PHY model to use when OFDMA is disabled (Yans or Spectrum). If 80+80 MHz or OFDMA is enabled then Spectrum is automatically selected [Yans] </dd>
1585 <dt>@c --minExpectedThroughput </dt>
1586 <dd>if set, simulation fails if the lowest throughput is below this value [0] </dd>
1587 <dt>@c --maxExpectedThroughput </dt>
1588 <dd>if set, simulation fails if the highest throughput is above this value [0] </dd>
1589</dl>
1590*/
1591/**
1592 @file wifi-hidden-terminal.cc
1593<h3>Usage</h3>
1594<code>$ ./ns3 run "wifi-hidden-terminal [Program Options]"</code>
1595
1596<h3>Program Options</h3>
1597<dl>
1598 <dt>@c --wifiManager </dt>
1599 <dd>Set wifi rate manager (Aarf, Aarfcd, Amrr, Arf, Cara, Ideal, Minstrel, Onoe, Rraa) [Arf] </dd>
1600</dl>
1601*/
1602/**
1603 @file wifi-ht-network.cc
1604<h3>Usage</h3>
1605<code>$ ./ns3 run "wifi-ht-network [Program Options]"</code>
1606
1607<h3>Program Options</h3>
1608<dl>
1609 <dt>@c --staticSetup </dt>
1610 <dd>Whether devices are configured using the static setup helper [true] </dd>
1611 <dt>@c --frequency </dt>
1612 <dd>Whether working in the 2.4 or 5.0 GHz band (other values gets rejected) [5] </dd>
1613 <dt>@c --distance </dt>
1614 <dd>Distance in meters between the station and the access point [1] </dd>
1615 <dt>@c --simulationTime </dt>
1616 <dd>Simulation time [+10s] </dd>
1617 <dt>@c --udp </dt>
1618 <dd>UDP if set to 1, TCP otherwise [true] </dd>
1619 <dt>@c --useRts </dt>
1620 <dd>Enable/disable RTS/CTS [false] </dd>
1621 <dt>@c --mcs </dt>
1622 <dd>list of comma separated MCS values to test; if unset, all MCS values (0-7) are tested </dd>
1623 <dt>@c --channelWidth </dt>
1624 <dd>if set, limit testing to a specific channel width expressed in MHz (20 or 40 MHz) [-1] </dd>
1625 <dt>@c --guardInterval </dt>
1626 <dd>if set, limit testing to a specific guard interval duration expressed in nanoseconds (800 or 400 ns) [-1] </dd>
1627 <dt>@c --minExpectedThroughput </dt>
1628 <dd>if set, simulation fails if the lowest throughput is below this value [0] </dd>
1629 <dt>@c --maxExpectedThroughput </dt>
1630 <dd>if set, simulation fails if the highest throughput is above this value [0] </dd>
1631</dl>
1632*/
1633/**
1634 @file wifi-manager-example.cc
1635<h3>Usage</h3>
1636<code>$ ./ns3 run "wifi-manager-example [Program Options]"</code>
1637
1638<h3>Program Options</h3>
1639<dl>
1640 <dt>@c --maxRetryCount </dt>
1641 <dd>The maximum number of retransmission attempts for a Data packet [7] </dd>
1642 <dt>@c --rtsThreshold </dt>
1643 <dd>RTS threshold [999999] </dd>
1644 <dt>@c --maxAmpduSize </dt>
1645 <dd>Max A-MPDU size [65535] </dd>
1646 <dt>@c --stepSize </dt>
1647 <dd>Power between steps (dBm) [1] </dd>
1648 <dt>@c --stepTime </dt>
1649 <dd>Time on each step (seconds) [1] </dd>
1650 <dt>@c --broadcast </dt>
1651 <dd>Send broadcast instead of unicast [false] </dd>
1652 <dt>@c --serverChannelWidth </dt>
1653 <dd>Set channel width of the server (valid only for 802.11n or ac) [0] </dd>
1654 <dt>@c --clientChannelWidth </dt>
1655 <dd>Set channel width of the client (valid only for 802.11n or ac) [0] </dd>
1656 <dt>@c --serverNss </dt>
1657 <dd>Set nss of the server (valid only for 802.11n or ac) [1] </dd>
1658 <dt>@c --clientNss </dt>
1659 <dd>Set nss of the client (valid only for 802.11n or ac) [1] </dd>
1660 <dt>@c --serverShortGuardInterval </dt>
1661 <dd>Set short guard interval of the server (802.11n/ac/ax) in nanoseconds [800] </dd>
1662 <dt>@c --clientShortGuardInterval </dt>
1663 <dd>Set short guard interval of the client (802.11n/ac/ax) in nanoseconds [800] </dd>
1664 <dt>@c --standard </dt>
1665 <dd>Set standard (802.11a, 802.11b, 802.11g, 802.11p-10MHz, 802.11p-5MHz, 802.11n-5GHz, 802.11n-2.4GHz, 802.11ac, 802.11ax-6GHz, 802.11ax-5GHz, 802.11ax-2.4GHz, 802.11be-6GHz, 802.11be-5GHz, 802.11be-2.4GHz) [802.11a] </dd>
1666 <dt>@c --wifiManager </dt>
1667 <dd>Set wifi rate manager (Aarf, Aarfcd, Amrr, Arf, Cara, Ideal, Minstrel, MinstrelHt, Onoe, Rraa, ThompsonSampling) [Ideal] </dd>
1668 <dt>@c --infrastructure </dt>
1669 <dd>Use infrastructure instead of adhoc [false] </dd>
1670</dl>
1671*/
1672/**
1673 @file wifi-mixed-network.cc
1674<h3>Usage</h3>
1675<code>$ ./ns3 run "wifi-mixed-network [Program Options]"</code>
1676
1677<h3>Program Options</h3>
1678<dl>
1679 <dt>@c --payloadSize </dt>
1680 <dd>Payload size in bytes [1472] </dd>
1681 <dt>@c --simulationTime </dt>
1682 <dd>Simulation time [+10s] </dd>
1683 <dt>@c --isUdp </dt>
1684 <dd>UDP if set to 1, TCP otherwise [true] </dd>
1685 <dt>@c --verifyResults </dt>
1686 <dd>Enable/disable results verification at the end of the simulation [false] </dd>
1687</dl>
1688*/
1689/**
1690 @file wifi-multicast.cc
1691<h3>Usage</h3>
1692<code>$ ./ns3 run "wifi-multicast [Program Options]"</code>
1693
1694<h3>Program Options</h3>
1695<dl>
1696 <dt>@c --logging </dt>
1697 <dd>turn on example log components [false] </dd>
1698 <dt>@c --verbose </dt>
1699 <dd>turn on all wifi log components [false] </dd>
1700 <dt>@c --pcap </dt>
1701 <dd>turn on pcap file output [false] </dd>
1702 <dt>@c --nStations </dt>
1703 <dd>number of non-AP stations [1] </dd>
1704 <dt>@c --simulationTime </dt>
1705 <dd>Simulation time [+10s] </dd>
1706 <dt>@c --payloadSize </dt>
1707 <dd>The application payload size in bytes [1000] </dd>
1708 <dt>@c --maxPackets </dt>
1709 <dd>The maximum number of packets to be generated by the application (0 for no limit) [10] </dd>
1710 <dt>@c --dataRate </dt>
1711 <dd>The application data rate [10000000bps] </dd>
1712 <dt>@c --rtsThreshold </dt>
1713 <dd>RTS threshold [65535] </dd>
1714 <dt>@c --rateManager </dt>
1715 <dd>The rate adaptation manager to use (Constant, Ideal, MinstrelHt) [Constant] </dd>
1716 <dt>@c --mcs </dt>
1717 <dd>The MCS to use if Constant rate adaptation manager is used [11] </dd>
1718 <dt>@c --targetAddress </dt>
1719 <dd>multicast target address [239.192.100.1] </dd>
1720 <dt>@c --accessCategory </dt>
1721 <dd>select the multicast traffic access category (AC_BE, AC_BK, AC_VI, AC_VO) [AC_BE] </dd>
1722 <dt>@c --gcrRetransmissionPolicy </dt>
1723 <dd>GCR retransmission policy for groupcast frames (NoAckNoRetry, GcrUr, GcrBlockAck) [NoAckNoRetry] </dd>
1724 <dt>@c --nRetriesGcrUr </dt>
1725 <dd>number of retries per groupcast frame when GCR-UR retransmission policy is used [7] </dd>
1726 <dt>@c --gcrProtection </dt>
1727 <dd>protection to use for GCR (Rts-Cts or Cts-To-Self) [Rts-Cts] </dd>
1728 <dt>@c --multicastFrameErrorRate </dt>
1729 <dd>artificial error rate for multicast frame [0] </dd>
1730 <dt>@c --maxAmpduLength </dt>
1731 <dd>maximum length in bytes of an A-MPDU [0] </dd>
1732 <dt>@c --minExpectedPackets </dt>
1733 <dd>if set, simulation fails if the lowest amount of received packets is below this value (in Mbit/s) [0] </dd>
1734 <dt>@c --maxExpectedPackets </dt>
1735 <dd>if set, simulation fails if the highest amount of received packets is above this value (in Mbit/s) [0] </dd>
1736 <dt>@c --minExpectedThroughput </dt>
1737 <dd>if set, simulation fails if the throughput is below this value [0] </dd>
1738 <dt>@c --maxExpectedThroughput </dt>
1739 <dd>if set, simulation fails if the throughput is above this value [0] </dd>
1740</dl>
1741*/
1742/**
1743 @file wifi-multirate.cc
1744<h3>Usage</h3>
1745<code>$ ./ns3 run "wifi-multirate [Program Options]"</code>
1746
1747<h3>Program Options</h3>
1748<dl>
1749 <dt>@c --packetSize </dt>
1750 <dd>packet size [2000] </dd>
1751 <dt>@c --totalTime </dt>
1752 <dd>simulation time [0.3] </dd>
1753 <dt>@c --samplingPeriod </dt>
1754 <dd>sampling period [0.1] </dd>
1755 <dt>@c --rtsThreshold </dt>
1756 <dd>rts threshold [2200] </dd>
1757 <dt>@c --rateManager </dt>
1758 <dd>type of rate [ns3::MinstrelWifiManager] </dd>
1759 <dt>@c --outputFileName </dt>
1760 <dd>output filename [minstrel] </dd>
1761 <dt>@c --enableRouting </dt>
1762 <dd>enable Routing [false] </dd>
1763 <dt>@c --enableMobility </dt>
1764 <dd>enable Mobility [false] </dd>
1765 <dt>@c --scenario </dt>
1766 <dd>scenario [4] </dd>
1767</dl>
1768*/
1769/**
1770 @file wifi-multi-tos.cc
1771<h3>Usage</h3>
1772<code>$ ./ns3 run "wifi-multi-tos [Program Options]"</code>
1773
1774<h3>Program Options</h3>
1775<dl>
1776 <dt>@c --nWifi </dt>
1777 <dd>Number of stations [4] </dd>
1778 <dt>@c --distance </dt>
1779 <dd>Distance in meters between the stations and the access point [1] </dd>
1780 <dt>@c --simulationTime </dt>
1781 <dd>Simulation time [+10s] </dd>
1782 <dt>@c --useRts </dt>
1783 <dd>Enable/disable RTS/CTS [false] </dd>
1784 <dt>@c --mcs </dt>
1785 <dd>MCS value (0 - 7) [7] </dd>
1786 <dt>@c --channelWidth </dt>
1787 <dd>Channel width in MHz [␔] </dd>
1788 <dt>@c --useShortGuardInterval </dt>
1789 <dd>Enable/disable short guard interval [false] </dd>
1790</dl>
1791*/
1792/**
1793 @file wifi-ofdm-he-validation.cc
1794<h3>Usage</h3>
1795<code>$ ./ns3 run "wifi-ofdm-he-validation [Program Options]"</code>
1796
1797<h3>Program Options</h3>
1798<dl>
1799 <dt>@c --FrameSize </dt>
1800 <dd>The frame size [1500] </dd>
1801</dl>
1802*/
1803/**
1804 @file wifi-ofdm-ht-validation.cc
1805<h3>Usage</h3>
1806<code>$ ./ns3 run "wifi-ofdm-ht-validation [Program Options]"</code>
1807
1808<h3>Program Options</h3>
1809<dl>
1810 <dt>@c --FrameSize </dt>
1811 <dd>The frame size in bytes [1500] </dd>
1812</dl>
1813*/
1814/**
1815 @file wifi-ofdm-validation.cc
1816<h3>Usage</h3>
1817<code>$ ./ns3 run "wifi-ofdm-validation [Program Options]"</code>
1818
1819<h3>Program Options</h3>
1820<dl>
1821 <dt>@c --FrameSize </dt>
1822 <dd>The frame size in bytes [1500] </dd>
1823</dl>
1824*/
1825/**
1826 @file wifi-ofdm-vht-validation.cc
1827<h3>Usage</h3>
1828<code>$ ./ns3 run "wifi-ofdm-vht-validation [Program Options]"</code>
1829
1830<h3>Program Options</h3>
1831<dl>
1832 <dt>@c --FrameSize </dt>
1833 <dd>The frame size in bytes [1500] </dd>
1834</dl>
1835*/
1836/**
1837 @file wifi-phy-configuration.cc
1838<h3>Usage</h3>
1839<code>$ ./ns3 run "wifi-phy-configuration [Program Options]"</code>
1840
1841<h3>Program Options</h3>
1842<dl>
1843 <dt>@c --testCase </dt>
1844 <dd>Test case [0] </dd>
1845 <dt>@c --printAttributes </dt>
1846 <dd>If true, print out attributes [false] </dd>
1847</dl>
1848*/
1849/**
1850 @file wifi-power-adaptation-distance.cc
1851<h3>Usage</h3>
1852<code>$ ./ns3 run "wifi-power-adaptation-distance [Program Options]"</code>
1853
1854<h3>Program Options</h3>
1855<dl>
1856 <dt>@c --manager </dt>
1857 <dd>PRC Manager [ns3::ParfWifiManager] </dd>
1858 <dt>@c --rtsThreshold </dt>
1859 <dd>RTS threshold [2346] </dd>
1860 <dt>@c --outputFileName </dt>
1861 <dd>Output filename [parf] </dd>
1862 <dt>@c --steps </dt>
1863 <dd>How many different distances to try [200] </dd>
1864 <dt>@c --stepsTime </dt>
1865 <dd>Time on each step [+1s] </dd>
1866 <dt>@c --stepsSize </dt>
1867 <dd>Distance between steps [1] </dd>
1868 <dt>@c --maxPower </dt>
1869 <dd>Maximum available transmission level (dbm). [17] </dd>
1870 <dt>@c --minPower </dt>
1871 <dd>Minimum available transmission level (dbm). [0] </dd>
1872 <dt>@c --powerLevels </dt>
1873 <dd>Number of transmission power levels available between TxPowerStart and TxPowerEnd included. [18] </dd>
1874 <dt>@c --AP1_x </dt>
1875 <dd>Position of AP1 in x coordinate [0] </dd>
1876 <dt>@c --AP1_y </dt>
1877 <dd>Position of AP1 in y coordinate [0] </dd>
1878 <dt>@c --STA1_x </dt>
1879 <dd>Position of STA1 in x coordinate [5] </dd>
1880 <dt>@c --STA1_y </dt>
1881 <dd>Position of STA1 in y coordinate [0] </dd>
1882</dl>
1883*/
1884/**
1885 @file wifi-power-adaptation-interference.cc
1886<h3>Usage</h3>
1887<code>$ ./ns3 run "wifi-power-adaptation-interference [Program Options]"</code>
1888
1889<h3>Program Options</h3>
1890<dl>
1891 <dt>@c --manager </dt>
1892 <dd>PRC Manager [ns3::ParfWifiManager] </dd>
1893 <dt>@c --rtsThreshold </dt>
1894 <dd>RTS threshold [2346] </dd>
1895 <dt>@c --outputFileName </dt>
1896 <dd>Output filename [parf] </dd>
1897 <dt>@c --simuTime </dt>
1898 <dd>Total simulation time (sec) [+1.66667min] </dd>
1899 <dt>@c --maxPower </dt>
1900 <dd>Maximum available transmission level (dbm). [17] </dd>
1901 <dt>@c --minPower </dt>
1902 <dd>Minimum available transmission level (dbm). [0] </dd>
1903 <dt>@c --powerLevels </dt>
1904 <dd>Number of transmission power levels available between TxPowerStart and TxPowerEnd included. [18] </dd>
1905 <dt>@c --AP1_x </dt>
1906 <dd>Position of AP1 in x coordinate [0] </dd>
1907 <dt>@c --AP1_y </dt>
1908 <dd>Position of AP1 in y coordinate [0] </dd>
1909 <dt>@c --STA1_x </dt>
1910 <dd>Position of STA1 in x coordinate [10] </dd>
1911 <dt>@c --STA1_y </dt>
1912 <dd>Position of STA1 in y coordinate [0] </dd>
1913 <dt>@c --AP2_x </dt>
1914 <dd>Position of AP2 in x coordinate [200] </dd>
1915 <dt>@c --AP2_y </dt>
1916 <dd>Position of AP2 in y coordinate [0] </dd>
1917 <dt>@c --STA2_x </dt>
1918 <dd>Position of STA2 in x coordinate [180] </dd>
1919 <dt>@c --STA2_y </dt>
1920 <dd>Position of STA2 in y coordinate [0] </dd>
1921</dl>
1922*/
1923/**
1924 @file wifi-rate-adaptation-distance.cc
1925<h3>Usage</h3>
1926<code>$ ./ns3 run "wifi-rate-adaptation-distance [Program Options]"</code>
1927
1928<h3>Program Options</h3>
1929<dl>
1930 <dt>@c --staManager </dt>
1931 <dd>Rate adaptation manager of the STA [ns3::MinstrelHtWifiManager] </dd>
1932 <dt>@c --apManager </dt>
1933 <dd>Rate adaptation manager of the AP [ns3::MinstrelHtWifiManager] </dd>
1934 <dt>@c --standard </dt>
1935 <dd>Wifi standard (a/b/g/n/ac only) [802.11n-5GHz] </dd>
1936 <dt>@c --shortGuardInterval </dt>
1937 <dd>Enable Short Guard Interval in all stations [false] </dd>
1938 <dt>@c --channelWidth </dt>
1939 <dd>Channel width of all the stations [20] </dd>
1940 <dt>@c --rtsThreshold </dt>
1941 <dd>RTS threshold [65535] </dd>
1942 <dt>@c --BeMaxAmpduSize </dt>
1943 <dd>BE Mac A-MPDU size [65535] </dd>
1944 <dt>@c --outputFileName </dt>
1945 <dd>Output filename [minstrelHT] </dd>
1946 <dt>@c --steps </dt>
1947 <dd>How many different distances to try [100] </dd>
1948 <dt>@c --stepsTime </dt>
1949 <dd>Time on each step [1] </dd>
1950 <dt>@c --stepsSize </dt>
1951 <dd>Distance between steps [1] </dd>
1952 <dt>@c --AP1_x </dt>
1953 <dd>Position of AP1 in x coordinate [0] </dd>
1954 <dt>@c --AP1_y </dt>
1955 <dd>Position of AP1 in y coordinate [0] </dd>
1956 <dt>@c --STA1_x </dt>
1957 <dd>Position of STA1 in x coordinate [5] </dd>
1958 <dt>@c --STA1_y </dt>
1959 <dd>Position of STA1 in y coordinate [0] </dd>
1960</dl>
1961*/
1962/**
1963 @file wifi-simple-adhoc.cc
1964<h3>Usage</h3>
1965<code>$ ./ns3 run "wifi-simple-adhoc [Program Options]"</code>
1966
1967<h3>Program Options</h3>
1968<dl>
1969 <dt>@c --phyMode </dt>
1970 <dd>Wifi Phy mode [DsssRate1Mbps] </dd>
1971 <dt>@c --rss </dt>
1972 <dd>received signal strength [-80] </dd>
1973 <dt>@c --packetSize </dt>
1974 <dd>size of application packet sent [1000] </dd>
1975 <dt>@c --numPackets </dt>
1976 <dd>number of packets generated [1] </dd>
1977 <dt>@c --interval </dt>
1978 <dd>interval between packets [+1s] </dd>
1979 <dt>@c --verbose </dt>
1980 <dd>turn on all WifiNetDevice log components [false] </dd>
1981</dl>
1982*/
1983/**
1984 @file wifi-simple-adhoc-grid.cc
1985<h3>Usage</h3>
1986<code>$ ./ns3 run "wifi-simple-adhoc-grid [Program Options]"</code>
1987
1988<h3>Program Options</h3>
1989<dl>
1990 <dt>@c --phyMode </dt>
1991 <dd>Wifi Phy mode [DsssRate1Mbps] </dd>
1992 <dt>@c --distance </dt>
1993 <dd>distance (m) [100] </dd>
1994 <dt>@c --packetSize </dt>
1995 <dd>size of application packet sent [1000] </dd>
1996 <dt>@c --numPackets </dt>
1997 <dd>number of packets generated [1] </dd>
1998 <dt>@c --interval </dt>
1999 <dd>interval (seconds) between packets [+1s] </dd>
2000 <dt>@c --verbose </dt>
2001 <dd>turn on all WifiNetDevice log components [false] </dd>
2002 <dt>@c --tracing </dt>
2003 <dd>turn on ascii and pcap tracing [false] </dd>
2004 <dt>@c --numNodes </dt>
2005 <dd>number of nodes [25] </dd>
2006 <dt>@c --sinkNode </dt>
2007 <dd>Receiver node number [0] </dd>
2008 <dt>@c --sourceNode </dt>
2009 <dd>Sender node number [24] </dd>
2010</dl>
2011*/
2012/**
2013 @file wifi-simple-ht-hidden-stations.cc
2014<h3>Usage</h3>
2015<code>$ ./ns3 run "wifi-simple-ht-hidden-stations [Program Options]"</code>
2016
2017<h3>Program Options</h3>
2018<dl>
2019 <dt>@c --nMpdus </dt>
2020 <dd>Number of aggregated MPDUs [1] </dd>
2021 <dt>@c --payloadSize </dt>
2022 <dd>Payload size in bytes [1472] </dd>
2023 <dt>@c --enableRts </dt>
2024 <dd>Enable RTS/CTS [false] </dd>
2025 <dt>@c --simulationTime </dt>
2026 <dd>Simulation time [+10s] </dd>
2027 <dt>@c --minExpectedThroughput </dt>
2028 <dd>if set, simulation fails if the lowest throughput is below this value [0] </dd>
2029 <dt>@c --maxExpectedThroughput </dt>
2030 <dd>if set, simulation fails if the highest throughput is above this value [0] </dd>
2031</dl>
2032*/
2033/**
2034 @file wifi-simple-infra.cc
2035<h3>Usage</h3>
2036<code>$ ./ns3 run "wifi-simple-infra [Program Options]"</code>
2037
2038<h3>Program Options</h3>
2039<dl>
2040 <dt>@c --phyMode </dt>
2041 <dd>Wifi Phy mode [DsssRate1Mbps] </dd>
2042 <dt>@c --rss </dt>
2043 <dd>received signal strength [-80] </dd>
2044 <dt>@c --packetSize </dt>
2045 <dd>size of application packet sent [1000] </dd>
2046 <dt>@c --numPackets </dt>
2047 <dd>number of packets generated [1] </dd>
2048 <dt>@c --interval </dt>
2049 <dd>interval between packets [+1s] </dd>
2050 <dt>@c --verbose </dt>
2051 <dd>turn on all WifiNetDevice log components [false] </dd>
2052</dl>
2053*/
2054/**
2055 @file wifi-simple-interference.cc
2056<h3>Usage</h3>
2057<code>$ ./ns3 run "wifi-simple-interference [Program Options]"</code>
2058
2059<h3>Program Options</h3>
2060<dl>
2061 <dt>@c --phyMode </dt>
2062 <dd>Wifi Phy mode [DsssRate1Mbps] </dd>
2063 <dt>@c --Prss </dt>
2064 <dd>Intended primary received signal strength (dBm) [-80] </dd>
2065 <dt>@c --Irss </dt>
2066 <dd>Intended interfering received signal strength (dBm) [-95] </dd>
2067 <dt>@c --delta </dt>
2068 <dd>time offset for interfering signal [+0fs] </dd>
2069 <dt>@c --PpacketSize </dt>
2070 <dd>size of application packet sent [1000] </dd>
2071 <dt>@c --IpacketSize </dt>
2072 <dd>size of interfering packet sent [1000] </dd>
2073 <dt>@c --verbose </dt>
2074 <dd>turn on all WifiNetDevice log components [false] </dd>
2075</dl>
2076*/
2077/**
2078 @file wifi-sleep.cc
2079<h3>Usage</h3>
2080<code>$ ./ns3 run "wifi-sleep [Program Options]"</code>
2081
2082<h3>Program Options</h3>
2083<dl>
2084 <dt>@c --dataRate </dt>
2085 <dd>Data rate [1000000bps] </dd>
2086 <dt>@c --packetSize </dt>
2087 <dd>size of application packet sent [1000] </dd>
2088 <dt>@c --duration </dt>
2089 <dd>duration of the experiment [+10s] </dd>
2090 <dt>@c --initialEnergy </dt>
2091 <dd>Initial Energy (Joule) of each node [7.5] </dd>
2092 <dt>@c --voltage </dt>
2093 <dd>Supply voltage (Joule) [3] </dd>
2094 <dt>@c --txPowerStart </dt>
2095 <dd>Minimum available transmission level (dbm) [0] </dd>
2096 <dt>@c --txPowerEnd </dt>
2097 <dd>Maximum available transmission level (dbm) [15] </dd>
2098 <dt>@c --nTxPowerLevels </dt>
2099 <dd>Number of transmission power levels available between txPowerStart and txPowerEnd included [16] </dd>
2100 <dt>@c --txPowerLevel </dt>
2101 <dd>Transmission power level [1] </dd>
2102 <dt>@c --idleCurrent </dt>
2103 <dd>The radio Idle current in Ampere [0.273] </dd>
2104 <dt>@c --txCurrent </dt>
2105 <dd>The radio Tx current in Ampere [0.38] </dd>
2106 <dt>@c --verbose </dt>
2107 <dd>turn on all WifiNetDevice log components [false] </dd>
2108</dl>
2109*/
2110/**
2111 @file wifi-spectrum-per-example.cc
2112<h3>Usage</h3>
2113<code>$ ./ns3 run "wifi-spectrum-per-example [Program Options]"</code>
2114
2115<h3>Program Options</h3>
2116<dl>
2117 <dt>@c --simulationTime </dt>
2118 <dd>Simulation time [+10s] </dd>
2119 <dt>@c --udp </dt>
2120 <dd>UDP if set to 1, TCP otherwise [true] </dd>
2121 <dt>@c --distance </dt>
2122 <dd>meters separation between nodes [50] </dd>
2123 <dt>@c --index </dt>
2124 <dd>restrict index to single value between 0 and 31 [256] </dd>
2125 <dt>@c --wifiType </dt>
2126 <dd>select ns3::SpectrumWifiPhy or ns3::YansWifiPhy [ns3::SpectrumWifiPhy] </dd>
2127 <dt>@c --errorModelType </dt>
2128 <dd>select ns3::NistErrorRateModel or ns3::YansErrorRateModel [ns3::NistErrorRateModel] </dd>
2129 <dt>@c --enablePcap </dt>
2130 <dd>enable pcap output [false] </dd>
2131</dl>
2132*/
2133/**
2134 @file wifi-spectrum-per-interference.cc
2135<h3>Usage</h3>
2136<code>$ ./ns3 run "wifi-spectrum-per-interference [Program Options]"</code>
2137
2138<h3>Program Options</h3>
2139<dl>
2140 <dt>@c --simulationTime </dt>
2141 <dd>Simulation time [+10s] </dd>
2142 <dt>@c --udp </dt>
2143 <dd>UDP if set to 1, TCP otherwise [true] </dd>
2144 <dt>@c --distance </dt>
2145 <dd>meters separation between nodes [50] </dd>
2146 <dt>@c --index </dt>
2147 <dd>restrict index to single value between 0 and 31 [256] </dd>
2148 <dt>@c --wifiType </dt>
2149 <dd>select ns3::SpectrumWifiPhy or ns3::YansWifiPhy [ns3::SpectrumWifiPhy] </dd>
2150 <dt>@c --errorModelType </dt>
2151 <dd>select ns3::NistErrorRateModel or ns3::YansErrorRateModel [ns3::NistErrorRateModel] </dd>
2152 <dt>@c --enablePcap </dt>
2153 <dd>enable pcap output [false] </dd>
2154 <dt>@c --waveformPower </dt>
2155 <dd>Waveform power (linear W) [0] </dd>
2156</dl>
2157*/
2158/**
2159 @file wifi-spectrum-saturation-example.cc
2160<h3>Usage</h3>
2161<code>$ ./ns3 run "wifi-spectrum-saturation-example [Program Options]"</code>
2162
2163<h3>Program Options</h3>
2164<dl>
2165 <dt>@c --simulationTime </dt>
2166 <dd>Simulation time [+10s] </dd>
2167 <dt>@c --distance </dt>
2168 <dd>meters separation between nodes [1] </dd>
2169 <dt>@c --index </dt>
2170 <dd>restrict index to single value between 0 and 63 [256] </dd>
2171 <dt>@c --wifiType </dt>
2172 <dd>select ns3::SpectrumWifiPhy or ns3::YansWifiPhy [ns3::SpectrumWifiPhy] </dd>
2173 <dt>@c --errorModelType </dt>
2174 <dd>select ns3::NistErrorRateModel or ns3::YansErrorRateModel [ns3::NistErrorRateModel] </dd>
2175 <dt>@c --enablePcap </dt>
2176 <dd>enable pcap output [false] </dd>
2177</dl>
2178*/
2179/**
2180 @file wifi-tcp.cc
2181<h3>Usage</h3>
2182<code>$ ./ns3 run "wifi-tcp [Program Options]"</code>
2183
2184<h3>Program Options</h3>
2185<dl>
2186 <dt>@c --payloadSize </dt>
2187 <dd>Payload size in bytes [1472] </dd>
2188 <dt>@c --dataRate </dt>
2189 <dd>Application data ate [100000000bps] </dd>
2190 <dt>@c --tcpVariant </dt>
2191 <dd>Transport protocol to use: TcpNewReno, TcpHybla, TcpHighSpeed, TcpHtcp, TcpVegas, TcpScalable, TcpVeno, TcpBic, TcpYeah, TcpIllinois, TcpWestwood, TcpWestwoodPlus, TcpLedbat [TcpNewReno] </dd>
2192 <dt>@c --phyRate </dt>
2193 <dd>Physical layer bitrate [HtMcs7] </dd>
2194 <dt>@c --simulationTime </dt>
2195 <dd>Simulation time in seconds [+10s] </dd>
2196 <dt>@c --pcap </dt>
2197 <dd>Enable/disable PCAP Tracing [false] </dd>
2198</dl>
2199*/
2200/**
2201 @file wifi-test-interference-helper.cc
2202<h3>Usage</h3>
2203<code>$ ./ns3 run "wifi-test-interference-helper [Program Options]"</code>
2204
2205<h3>Program Options</h3>
2206<dl>
2207 <dt>@c --delay </dt>
2208 <dd>Delay between frame transmission from sender A and frame transmission from sender B [+0fs] </dd>
2209 <dt>@c --xA </dt>
2210 <dd>The position of transmitter A (< 0) [-5] </dd>
2211 <dt>@c --xB </dt>
2212 <dd>The position of transmitter B (> 0) [5] </dd>
2213 <dt>@c --packetSizeA </dt>
2214 <dd>Packet size in bytes of transmitter A [1500] </dd>
2215 <dt>@c --packetSizeB </dt>
2216 <dd>Packet size in bytes of transmitter B [1500] </dd>
2217 <dt>@c --txPowerA </dt>
2218 <dd>TX power of transmitter A [16.0206] </dd>
2219 <dt>@c --txPowerB </dt>
2220 <dd>TX power of transmitter B [16.0206] </dd>
2221 <dt>@c --txModeA </dt>
2222 <dd>Wifi mode used for payload transmission of sender A [OfdmRate54Mbps] </dd>
2223 <dt>@c --txModeB </dt>
2224 <dd>Wifi mode used for payload transmission of sender B [OfdmRate54Mbps] </dd>
2225 <dt>@c --channelA </dt>
2226 <dd>The selected channel number of sender A [$] </dd>
2227 <dt>@c --channelB </dt>
2228 <dd>The selected channel number of sender B [$] </dd>
2229 <dt>@c --widthA </dt>
2230 <dd>The selected channel width (MHz) of sender A [20] </dd>
2231 <dt>@c --widthB </dt>
2232 <dd>The selected channel width (MHz) of sender B [20] </dd>
2233 <dt>@c --standard </dt>
2234 <dd>IEEE 802.11 flavor [WIFI_PHY_STANDARD_80211a] </dd>
2235 <dt>@c --preamble </dt>
2236 <dd>Type of preamble [WIFI_PREAMBLE_LONG] </dd>
2237 <dt>@c --enableCapture </dt>
2238 <dd>Enable/disable physical layer capture [false] </dd>
2239 <dt>@c --captureMargin </dt>
2240 <dd>Margin used for physical layer capture [0] </dd>
2241 <dt>@c --checkResults </dt>
2242 <dd>Used to check results at the end of the test [false] </dd>
2243 <dt>@c --expectRxASuccessful </dt>
2244 <dd>Indicate whether packet A is expected to be successfully received [false] </dd>
2245 <dt>@c --expectRxBSuccessful </dt>
2246 <dd>Indicate whether packet B is expected to be successfully received [false] </dd>
2247</dl>
2248*/
2249/**
2250 @file wifi-timing-attributes.cc
2251<h3>Usage</h3>
2252<code>$ ./ns3 run "wifi-timing-attributes [Program Options]"</code>
2253
2254<h3>Program Options</h3>
2255<dl>
2256 <dt>@c --slot </dt>
2257 <dd>Slot time [+9us] </dd>
2258 <dt>@c --sifs </dt>
2259 <dd>SIFS duration [+10us] </dd>
2260 <dt>@c --pifs </dt>
2261 <dd>PIFS duration [+19us] </dd>
2262 <dt>@c --simulationTime </dt>
2263 <dd>Simulation time [+10s] </dd>
2264</dl>
2265*/
2266/**
2267 @file wifi-txop-aggregation.cc
2268<h3>Usage</h3>
2269<code>$ ./ns3 run "wifi-txop-aggregation [Program Options]"</code>
2270
2271<h3>Program Options</h3>
2272<dl>
2273 <dt>@c --payloadSize </dt>
2274 <dd>Payload size in bytes [1472] </dd>
2275 <dt>@c --enableRts </dt>
2276 <dd>Enable or disable RTS/CTS [false] </dd>
2277 <dt>@c --txopLimit </dt>
2278 <dd>TXOP duration in microseconds [3520] </dd>
2279 <dt>@c --simulationTime </dt>
2280 <dd>Simulation time [+10s] </dd>
2281 <dt>@c --distance </dt>
2282 <dd>Distance in meters between the station and the access point [5] </dd>
2283 <dt>@c --enablePcap </dt>
2284 <dd>Enable/disable pcap file generation [false] </dd>
2285 <dt>@c --verifyResults </dt>
2286 <dd>Enable/disable results verification at the end of the simulation [false] </dd>
2287</dl>
2288*/
2289/**
2290 @file wifi-vht-network.cc
2291<h3>Usage</h3>
2292<code>$ ./ns3 run "wifi-vht-network [Program Options]"</code>
2293
2294<h3>Program Options</h3>
2295<dl>
2296 <dt>@c --staticSetup </dt>
2297 <dd>Whether devices are configured using the static setup helper [true] </dd>
2298 <dt>@c --distance </dt>
2299 <dd>Distance in meters between the station and the access point [1] </dd>
2300 <dt>@c --simulationTime </dt>
2301 <dd>Simulation time [+10s] </dd>
2302 <dt>@c --udp </dt>
2303 <dd>UDP if set to 1, TCP otherwise [true] </dd>
2304 <dt>@c --useRts </dt>
2305 <dd>Enable/disable RTS/CTS [false] </dd>
2306 <dt>@c --use80Plus80 </dt>
2307 <dd>Enable/disable use of 80+80 MHz [false] </dd>
2308 <dt>@c --mcs </dt>
2309 <dd>list of comma separated MCS values to test; if unset, all MCS values (0-9) are tested </dd>
2310 <dt>@c --phyModel </dt>
2311 <dd>PHY model to use (Yans or Spectrum). If 80+80 MHz is enabled, then Spectrum is automatically selected [Yans] </dd>
2312 <dt>@c --channelWidth </dt>
2313 <dd>if set, limit testing to a specific channel width expressed in MHz (20, 40, 80 or 160 MHz) [-1] </dd>
2314 <dt>@c --guardInterval </dt>
2315 <dd>if set, limit testing to a specific guard interval duration expressed in nanoseconds (800 or 400 ns) [-1] </dd>
2316 <dt>@c --minExpectedThroughput </dt>
2317 <dd>if set, simulation fails if the lowest throughput is below this value [0] </dd>
2318 <dt>@c --maxExpectedThroughput </dt>
2319 <dd>if set, simulation fails if the highest throughput is above this value [0] </dd>
2320</dl>
2321*/
2322/**
2323 @file wifi-wired-bridging.cc
2324<h3>Usage</h3>
2325<code>$ ./ns3 run "wifi-wired-bridging [Program Options]"</code>
2326
2327<h3>Program Options</h3>
2328<dl>
2329 <dt>@c --nWifis </dt>
2330 <dd>Number of wifi networks [2] </dd>
2331 <dt>@c --nStas </dt>
2332 <dd>Number of stations per wifi network [2] </dd>
2333 <dt>@c --SendIp </dt>
2334 <dd>Send Ipv4 or raw packets [true] </dd>
2335 <dt>@c --writeMobility </dt>
2336 <dd>Write mobility trace [false] </dd>
2337</dl>
2338*/
2339/**
2340 @file wireless-animation.cc
2341<h3>Usage</h3>
2342<code>$ ./ns3 run "wireless-animation [Program Options]"</code>
2343
2344<h3>Program Options</h3>
2345<dl>
2346 <dt>@c --nWifi </dt>
2347 <dd>Number of wifi STA devices [20] </dd>
2348</dl>
2349*/