-
Notifications
You must be signed in to change notification settings - Fork 0
/
example4.html
634 lines (543 loc) · 36.9 KB
/
example4.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>example4 module — PyMoSim v0.8 Manual</title>
<link href="_static/css/theme.css" rel="stylesheet" />
<link href="_static/css/index.c5995385ac14fb8791e8eb36b4908be2.css" rel="stylesheet" />
<link rel="stylesheet"
href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="preload" as="script" href="_static/js/index.1c5a1a01449ed65a7b51.js">
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-fluid" id="banner"></div>
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="container-xl">
<div id="navbar-start">
<a class="navbar-brand" href="index.html">
<img src="_static/icon.png" class="logo" alt="logo">
</a>
</div>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
<div id="navbar-center" class="mr-auto">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="comm.html">
comm package
</a>
</li>
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="node.html">
node package
</a>
</li>
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="sim.html">
sim package
</a>
</li>
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="map.html">
map package
</a>
</li>
</ul>
</div>
</div>
<div id="navbar-end">
<div class="navbar-end-item">
<form class="bd-search d-flex align-items-center" action="search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/cfoh/pymosim" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<!-- Only show if we have sidebars configured, else just a small margin -->
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
</div>
</nav>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<div class="toc-item">
<nav id="bd-toc-nav">
</nav>
</div>
<div class="toc-item">
</div>
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<div class="section" id="module-example4">
<span id="example4-module"></span><h1>example4 module<a class="headerlink" href="#module-example4" title="Permalink to this headline">¶</a></h1>
<p>This is an example demonstrating a number of vehicles following random waypoint
mobility moving on the map which contains a number of sectorized small cell base
stations. The simulation runs non-stop.</p>
<p>In this example, we use vehicle centric where vehicle will send a hello beacon message
to collect reply packet quality from all sectors of all BSs, and then associate with
the sector with the highest quality (i.e. strongest SNR).</p>
<dl class="py class">
<dt id="example4.DebugPrint">
<em class="property">class </em><code class="sig-prename descclassname">example4.</code><code class="sig-name descname">DebugPrint</code><a class="headerlink" href="#example4.DebugPrint" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p class="rubric">Methods</p>
<table class="table">
<colgroup>
<col style="width: 47%" />
<col style="width: 53%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>print</strong></p></td>
<td></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="example4.DebugPrint.print">
<code class="sig-name descname">print</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kw</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.DebugPrint.print" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="example4.MySector">
<em class="property">class </em><code class="sig-prename descclassname">example4.</code><code class="sig-name descname">MySector</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">simworld</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">loc</span></em>, <em class="sig-param"><span class="n">freq</span></em>, <em class="sig-param"><span class="n">channel</span></em>, <em class="sig-param"><span class="n">sector_width</span></em>, <em class="sig-param"><span class="n">sector_dir</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MySector" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="node.node.html#node.node.BaseNode" title="node.node.BaseNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">node.node.BaseNode</span></code></a></p>
<p>MySector: This is a sector of a base station in the VANET sim world</p>
<p class="rubric">Methods</p>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">ID</span></code>(id_str)</p></td>
<td><p>The data structure for the node id.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Type</span></code>(node_type)</p></td>
<td><p>The definition of a node type.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">clear_drawing</span></code>()</p></td>
<td><p>Clear the drawing for this node by removing all drawables associated with this node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_circle</span></code>(radius)</p></td>
<td><p>(Deprecated) Remove an earlier added circle for this node.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_drawable</span></code>(drawable)</p></td>
<td><p>Remove a specific drawable from the drawing list.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_line</span></code>(other_node)</p></td>
<td><p>(Deprecated) Remove an earlier added line for this node.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_sector</span></code>(radius, pointing_angle, width_angle)</p></td>
<td><p>(Deprecated) Remove an earlier added sector drawing.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_text</span></code>(dx, dy, text)</p></td>
<td><p>(Deprecated) Remove an earlier added text message.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_circle</span></code>(radius[, pen, brush])</p></td>
<td><p>Put a circle around this node where the node is the center of the circle.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_line</span></code>(other_node[, pen, brush])</p></td>
<td><p>Draw a line from this node to <cite>other_node</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_line_segments</span></code>(points[, pen, brush])</p></td>
<td><p>Draw line segments around this node where (0,0) is the center of the node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_sector</span></code>(radius, pointing_angle, width_angle)</p></td>
<td><p>Draw a sector where its center is at this node, its radius is <cite>radius</cite> its pointing angle is <cite>pointing_angle</cite>, its width (in degree) is specified in <cite>width_angle</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_text</span></code>(dx, dy, text, font[, foreground, …])</p></td>
<td><p>Draw a text at around this node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code>(query_str)</p></td>
<td><p>Query the node to retrieve corresponding information.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_color</span></code>()</p></td>
<td><p>Get the color that is used to draw this node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_node_list</span></code>()</p></td>
<td><p>Provide the list of all nodes.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_disabled</span></code>()</p></td>
<td><p>Use this method to check if a node is disabled.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_visible</span></code>()</p></td>
<td><p>Use this method to check if a node is visible.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">lookup</span></code>(id)</p></td>
<td><p>This is a static method for performing a lookup for the node with <cite>id</cite>.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_from_simulation</span></code>()</p></td>
<td><p>This method is used to remove this node from the simulation.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code>()</p></td>
<td><p>Reset the global node list.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset_color</span></code>()</p></td>
<td><p>Reset the color for the node to the default color of <cite>wx.BLACK</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_color</span></code>(color)</p></td>
<td><p>Set the color to draw for this node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_mobility</span></code>(mobility[, direction])</p></td>
<td><p>Set the <cite>mobility</cite> for this instance.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_transceiver</span></code>(transceiver)</p></td>
<td><p>Use this method to set a transceiver for the node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_visible</span></code>([flag])</p></td>
<td><p>Use this method to set the visibility of a node.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#example4.MySector.show_coverage" title="example4.MySector.show_coverage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">show_coverage</span></code></a>()</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="example4.MySector.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">simworld</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">loc</span></em>, <em class="sig-param"><span class="n">freq</span></em>, <em class="sig-param"><span class="n">channel</span></em>, <em class="sig-param"><span class="n">sector_width</span></em>, <em class="sig-param"><span class="n">sector_dir</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MySector.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the constructor. It must be reimplemented and
super() must be called.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>simworld</strong><span class="classifier"><a class="reference internal" href="sim.simulation.html#sim.simulation.World" title="sim.simulation.World"><code class="xref py py-class docutils literal notranslate"><span class="pre">sim.simulation.World</span></code></a></span></dt><dd><p>To provide the container of the node to be initiated.</p>
</dd>
<dt><strong>id</strong><span class="classifier"><a class="reference internal" href="node.node.html#node.node.BaseNode.ID" title="node.node.BaseNode.ID"><code class="xref py py-class docutils literal notranslate"><span class="pre">node.node.BaseNode.ID</span></code></a>, default=None</span></dt><dd><p>To provide the <cite>id</cite> of this node.</p>
</dd>
<dt><strong>type</strong><span class="classifier"><a class="reference internal" href="node.node.html#node.node.BaseNode.Type" title="node.node.BaseNode.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">node.node.BaseNode.Type</span></code></a>, default=None</span></dt><dd><p>To specify the <cite>type</cite> of this node.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="example4.MySector.show_coverage">
<code class="sig-name descname">show_coverage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#example4.MySector.show_coverage" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="example4.MyVehicle">
<em class="property">class </em><code class="sig-prename descclassname">example4.</code><code class="sig-name descname">MyVehicle</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">simworld</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">freq</span></em>, <em class="sig-param"><span class="n">channel</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyVehicle" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="node.node.html#node.node.BaseNode" title="node.node.BaseNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">node.node.BaseNode</span></code></a></p>
<p>MyVehicle: This is a transmitting node in the VANET sim world</p>
<p class="rubric">Methods</p>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">ID</span></code>(id_str)</p></td>
<td><p>The data structure for the node id.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Type</span></code>(node_type)</p></td>
<td><p>The definition of a node type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#example4.MyVehicle.associate_sector" title="example4.MyVehicle.associate_sector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">associate_sector</span></code></a>(sector, time)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">clear_drawing</span></code>()</p></td>
<td><p>Clear the drawing for this node by removing all drawables associated with this node.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_circle</span></code>(radius)</p></td>
<td><p>(Deprecated) Remove an earlier added circle for this node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_drawable</span></code>(drawable)</p></td>
<td><p>Remove a specific drawable from the drawing list.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_line</span></code>(other_node)</p></td>
<td><p>(Deprecated) Remove an earlier added line for this node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_sector</span></code>(radius, pointing_angle, width_angle)</p></td>
<td><p>(Deprecated) Remove an earlier added sector drawing.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">del_text</span></code>(dx, dy, text)</p></td>
<td><p>(Deprecated) Remove an earlier added text message.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_circle</span></code>(radius[, pen, brush])</p></td>
<td><p>Put a circle around this node where the node is the center of the circle.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_line</span></code>(other_node[, pen, brush])</p></td>
<td><p>Draw a line from this node to <cite>other_node</cite>.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_line_segments</span></code>(points[, pen, brush])</p></td>
<td><p>Draw line segments around this node where (0,0) is the center of the node.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_sector</span></code>(radius, pointing_angle, width_angle)</p></td>
<td><p>Draw a sector where its center is at this node, its radius is <cite>radius</cite> its pointing angle is <cite>pointing_angle</cite>, its width (in degree) is specified in <cite>width_angle</cite>.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_text</span></code>(dx, dy, text, font[, foreground, …])</p></td>
<td><p>Draw a text at around this node.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code>(query_str)</p></td>
<td><p>Query the node to retrieve corresponding information.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_color</span></code>()</p></td>
<td><p>Get the color that is used to draw this node.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_node_list</span></code>()</p></td>
<td><p>Provide the list of all nodes.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_disabled</span></code>()</p></td>
<td><p>Use this method to check if a node is disabled.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_visible</span></code>()</p></td>
<td><p>Use this method to check if a node is visible.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">lookup</span></code>(id)</p></td>
<td><p>This is a static method for performing a lookup for the node with <cite>id</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#example4.MyVehicle.lost_sector" title="example4.MyVehicle.lost_sector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lost_sector</span></code></a>(time)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_from_simulation</span></code>()</p></td>
<td><p>This method is used to remove this node from the simulation.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset</span></code>()</p></td>
<td><p>Reset the global node list.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset_color</span></code>()</p></td>
<td><p>Reset the color for the node to the default color of <cite>wx.BLACK</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_color</span></code>(color)</p></td>
<td><p>Set the color to draw for this node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_mobility</span></code>(mobility[, direction])</p></td>
<td><p>Set the <cite>mobility</cite> for this instance.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_transceiver</span></code>(transceiver)</p></td>
<td><p>Use this method to set a transceiver for the node.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_visible</span></code>([flag])</p></td>
<td><p>Use this method to set the visibility of a node.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#example4.MyVehicle.show_connection" title="example4.MyVehicle.show_connection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">show_connection</span></code></a>()</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="example4.MyVehicle.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">simworld</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">freq</span></em>, <em class="sig-param"><span class="n">channel</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyVehicle.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the constructor. It must be reimplemented and
super() must be called.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>simworld</strong><span class="classifier"><a class="reference internal" href="sim.simulation.html#sim.simulation.World" title="sim.simulation.World"><code class="xref py py-class docutils literal notranslate"><span class="pre">sim.simulation.World</span></code></a></span></dt><dd><p>To provide the container of the node to be initiated.</p>
</dd>
<dt><strong>id</strong><span class="classifier"><a class="reference internal" href="node.node.html#node.node.BaseNode.ID" title="node.node.BaseNode.ID"><code class="xref py py-class docutils literal notranslate"><span class="pre">node.node.BaseNode.ID</span></code></a>, default=None</span></dt><dd><p>To provide the <cite>id</cite> of this node.</p>
</dd>
<dt><strong>type</strong><span class="classifier"><a class="reference internal" href="node.node.html#node.node.BaseNode.Type" title="node.node.BaseNode.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">node.node.BaseNode.Type</span></code></a>, default=None</span></dt><dd><p>To specify the <cite>type</cite> of this node.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="example4.MyVehicle.associate_sector">
<code class="sig-name descname">associate_sector</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sector</span></em>, <em class="sig-param"><span class="n">time</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyVehicle.associate_sector" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="example4.MyVehicle.lost_sector">
<code class="sig-name descname">lost_sector</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">time</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyVehicle.lost_sector" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="example4.MyVehicle.show_connection">
<code class="sig-name descname">show_connection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyVehicle.show_connection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="example4.MyScenario">
<em class="property">class </em><code class="sig-prename descclassname">example4.</code><code class="sig-name descname">MyScenario</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">simworld</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyScenario" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="sim.scenario.html#sim.scenario.BaseScenario" title="sim.scenario.BaseScenario"><code class="xref py py-class docutils literal notranslate"><span class="pre">sim.scenario.BaseScenario</span></code></a>, <a class="reference internal" href="#example4.DebugPrint" title="example4.DebugPrint"><code class="xref py py-class docutils literal notranslate"><span class="pre">example4.DebugPrint</span></code></a></p>
<p>MyScenario: This is my scenario</p>
<p class="rubric">Methods</p>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_button</span></code>(id, label)</p></td>
<td><p>Add a button to the user defined space on the simulation window.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_drawable</span></code>(drawable)</p></td>
<td><p>Use this method to add a persistent drawable on the scenario background.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">change_sim_stop_time</span></code>(new_time)</p></td>
<td><p>Change the simulation stop time to a new stop time.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#example4.MyScenario.do_create_path" title="example4.MyScenario.do_create_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">do_create_path</span></code></a>(sim_time, event_obj)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#example4.MyScenario.do_mobility" title="example4.MyScenario.do_mobility"><code class="xref py py-obj docutils literal notranslate"><span class="pre">do_mobility</span></code></a>(sim_time, event_obj)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#example4.MyScenario.get_random_loc" title="example4.MyScenario.get_random_loc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_random_loc</span></code></a>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_setting</span></code>(setting_str)</p></td>
<td><p>Get the simulation setting.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">has_map</span></code>()</p></td>
<td><p>Check whether this scenario has a valid street map object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#example4.MyScenario.on_create" title="example4.MyScenario.on_create"><code class="xref py py-obj docutils literal notranslate"><span class="pre">on_create</span></code></a>(simworld)</p></td>
<td><p>This is an event listener which will be called when the scenario object is being created.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#example4.MyScenario.on_event" title="example4.MyScenario.on_event"><code class="xref py py-obj docutils literal notranslate"><span class="pre">on_event</span></code></a>(sim_time, event_obj)</p></td>
<td><p>This is an event listener which will be called when an event occurs.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#example4.MyScenario.print_statistics" title="example4.MyScenario.print_statistics"><code class="xref py py-obj docutils literal notranslate"><span class="pre">print_statistics</span></code></a>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_drawable</span></code>(drawable)</p></td>
<td><p>Use this method to remove a persistent drawable from the scenario background.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_background</span></code>(bitmap[, x, y, zoom])</p></td>
<td><p>Set a background bitmap image for this scenario.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_name</span></code>(name)</p></td>
<td><p>Set a name for this scenario to show on the window.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">sim__get_control</span></code>()</p></td>
<td><p>Get the user defined contols.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">use_map</span></code>(map[, x, y, zoom])</p></td>
<td><p>Set a street map info object for this scenario to describe the map.</p></td>
</tr>
</tbody>
</table>
<table class="table">
<colgroup>
<col style="width: 47%" />
<col style="width: 53%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>print</strong></p></td>
<td></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="example4.MyScenario.on_create">
<code class="sig-name descname">on_create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">simworld</span></em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#example4.MyScenario.on_create" title="Permalink to this definition">¶</a></dt>
<dd><p>This is an event listener which will be called when the scenario
object is being created. The subclass should extend this method
to create the simulation world.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When creating variables for the subclass, DO NOT use variable names
beginning with two underscores. This might clash with the variable
used internally in the base class.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><dl class="simple">
<dt>bool</dt><dd><p>True if the scenario is created successfully, False otherwise.
Returning False will cause the simulation to throw a runtime error.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="example4.MyScenario.get_random_loc">
<code class="sig-name descname">get_random_loc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyScenario.get_random_loc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="example4.MyScenario.on_event">
<code class="sig-name descname">on_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sim_time</span></em>, <em class="sig-param"><span class="n">event_obj</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyScenario.on_event" title="Permalink to this definition">¶</a></dt>
<dd><p>This is an event listener which will be called when an event occurs.</p>
<p>The simulation periodically calls this method to allow user to perform
any user simulation for every time step of mobility. In other words,
the simulation continuously progresses a simulation time step, freezes
the time and calls this method.</p>
<p>A subclass must extend this method to perform any necessary user
simulation on the simulation world.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>sim_time</strong><span class="classifier">float</span></dt><dd><p>The simulation time that the event happens.</p>
</dd>
<dt><strong>event_object</strong><span class="classifier"><a class="reference internal" href="sim.event.html#sim.event.Event" title="sim.event.Event"><code class="xref py py-class docutils literal notranslate"><span class="pre">sim.event.Event</span></code></a></span></dt><dd><p>The event object describing what has happened. The user should
check the type of the event object and handle the event accordingly.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="example4.MyScenario.do_create_path">
<code class="sig-name descname">do_create_path</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sim_time</span></em>, <em class="sig-param"><span class="n">event_obj</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyScenario.do_create_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="example4.MyScenario.do_mobility">
<code class="sig-name descname">do_mobility</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sim_time</span></em>, <em class="sig-param"><span class="n">event_obj</span></em><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyScenario.do_mobility" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="example4.MyScenario.print_statistics">
<code class="sig-name descname">print_statistics</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#example4.MyScenario.print_statistics" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</main>
</div>
</div>
<script src="_static/js/index.1c5a1a01449ed65a7b51.js"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<div class="footer-item">
<p class="copyright">
© Copyright 2021, cfoh.<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3.<br/>
</p>
</div>
</div>
</footer>
</body>
</html>