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