-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnode.mobility.html
More file actions
858 lines (753 loc) · 43.5 KB
/
Copy pathnode.mobility.html
File metadata and controls
858 lines (753 loc) · 43.5 KB
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
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>node.mobility 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" />
<link rel="next" title="node.mobility2 module" href="node.mobility2.html" />
<link rel="prev" title="node.draw module" href="node.draw.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 current active 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">
<ul class="current nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="node.draw.html">
node.draw module
</a>
</li>
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
node.mobility module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="node.mobility2.html">
node.mobility2 module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="node.mobility2b.html">
node.mobility2b module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="node.mobility3.html">
node.mobility3 module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="node.node.html">
node.node module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="node.obstacle.html">
node.obstacle module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="node.routemobi.html">
node.routemobi module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="node.timer.html">
node.timer module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="node.type.html">
node.type module
</a>
</li>
</ul>
</div>
</nav>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<div class="toc-item">
<div class="tocsection onthispage pt-5 pb-3">
<i class="fas fa-list"></i> On this page
</div>
<nav id="bd-toc-nav">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#list-of-classes">
List of Classes
</a>
<ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#basemobility">
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
BaseMobility
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#stationary">
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
Stationary
</span>
</code>
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#staticpath">
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
StaticPath
</span>
</code>
</a>
</li>
</ul>
</li>
</ul>
</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-node.mobility">
<span id="node-mobility-module"></span><h1>node.mobility module<a class="headerlink" href="#module-node.mobility" title="Permalink to this headline">¶</a></h1>
<p>Module <cite>mobility</cite> contains various classes to describe node mobility.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>Created by: CH Foh (2021)</p></li>
</ul>
</div>
<div class="section" id="list-of-classes">
<h2>List of Classes<a class="headerlink" href="#list-of-classes" title="Permalink to this headline">¶</a></h2>
<div class="section" id="basemobility">
<h3><a class="reference internal" href="#node.mobility.BaseMobility" title="node.mobility.BaseMobility"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseMobility</span></code></a><a class="headerlink" href="#basemobility" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><p>This is the base mobility. It provides specification and several
useful methods.</p>
</div></blockquote>
</div>
<div class="section" id="stationary">
<h3><a class="reference internal" href="#node.mobility.Stationary" title="node.mobility.Stationary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Stationary</span></code></a><a class="headerlink" href="#stationary" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><p>This is a class used for none moving node.</p>
</div></blockquote>
</div>
<div class="section" id="staticpath">
<h3><a class="reference internal" href="#node.mobility.StaticPath" title="node.mobility.StaticPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">StaticPath</span></code></a><a class="headerlink" href="#staticpath" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><p>This is a static mobility model. It describes a predefined
mobility and the mobility is executed in a static way. The model
may be used in a dynamic way, but the user simulation must
redefine the model in the simulation event to make that happens.</p>
</div></blockquote>
<hr class="docutils" />
<dl class="py class">
<dt id="node.mobility.BaseMobility">
<em class="property">class </em><code class="sig-prename descclassname">node.mobility.</code><code class="sig-name descname">BaseMobility</code><a class="headerlink" href="#node.mobility.BaseMobility" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
<p>This is an abstract base class for all mobility classes to extend. Use
<cite>node.mobility.BaseMobility.get_name()</cite> to find out which subclass this
instance belong to.</p>
<p>The subclass can access to several convenient functions
via the base class.</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><a class="reference internal" href="#node.mobility.BaseMobility.get_dir" title="node.mobility.BaseMobility.get_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_dir</span></code></a>()</p></td>
<td><p>This method returns the current direction.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.get_displacement" title="node.mobility.BaseMobility.get_displacement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_displacement</span></code></a>()</p></td>
<td><p>This method returns the displacement of the node in the last simulation time step.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.get_loc" title="node.mobility.BaseMobility.get_loc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_loc</span></code></a>()</p></td>
<td><p>This method returns the current location.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.get_name" title="node.mobility.BaseMobility.get_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name</span></code></a>()</p></td>
<td><p>Call this method to get the name of this class, which is useful to find out which subclass this instance belong to.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.get_node" title="node.mobility.BaseMobility.get_node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_node</span></code></a>()</p></td>
<td><p>Get the node that uses this mobility instance.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.get_speed" title="node.mobility.BaseMobility.get_speed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_speed</span></code></a>()</p></td>
<td><p>This method returns the targeted travelling speed.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.is_pause" title="node.mobility.BaseMobility.is_pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_pause</span></code></a>()</p></td>
<td><p>Check if the movement of the node is paused.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.pause" title="node.mobility.BaseMobility.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pause</span></code></a>([pause_flag])</p></td>
<td><p>Apply a pause to the movement of the node, or resume the movement from a pause.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.set_dir" title="node.mobility.BaseMobility.set_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_dir</span></code></a>(direction)</p></td>
<td><p>This method provides a direction to this mobility model.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.BaseMobility.sim__do_move" title="node.mobility.BaseMobility.sim__do_move"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sim__do_move</span></code></a>(time_step)</p></td>
<td><p>Call this method to make this node to move over a <cite>time_step</cite>.</p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="node.mobility.BaseMobility.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Default constructor.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.get_name">
<em class="property">abstract </em><code class="sig-name descname">get_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.get_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this method to get the name of this class, which is useful to
find out which subclass this instance belong to. This method must be
reimplemented in the subclass and the method should return a unique name.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><dl class="simple">
<dt>str</dt><dd><p>The string describing name of this class.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.sim__do_move">
<em class="property">abstract </em><code class="sig-name descname">sim__do_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">time_step</span></em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#node.mobility.BaseMobility.sim__do_move" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this method to make this node to move over a <cite>time_step</cite>.
This method is used within the simulation engine, not for user simulation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>time_step</strong><span class="classifier">float</span></dt><dd><p>The time to move forward to (in seconds).</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>bool</dt><dd><p>It indicates whether the provided movement for this class is completed
and that no more movement is to be performed.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.get_loc">
<em class="property">abstract </em><code class="sig-name descname">get_loc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.get_loc" title="Permalink to this definition">¶</a></dt>
<dd><p>This method returns the current location.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><dl class="simple">
<dt>sim.loc.LOC subclass</dt><dd><p>The current location.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.get_speed">
<em class="property">abstract </em><code class="sig-name descname">get_speed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.get_speed" title="Permalink to this definition">¶</a></dt>
<dd><p>This method returns the targeted travelling speed. The actual speed may be
lower due to other slow moving vehicles in front.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><dl class="simple">
<dt>float</dt><dd><p>The current speed, non-negative.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.get_dir">
<em class="property">abstract </em><code class="sig-name descname">get_dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.get_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>This method returns the current direction.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><dl class="simple">
<dt>sim.direction.DIR subclass</dt><dd><p>The current direction.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.set_dir">
<em class="property">abstract </em><code class="sig-name descname">set_dir</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">direction</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.set_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>This method provides a direction to this mobility model.</p>
<p>Providing a direction to a node is needed when the node is stationary.
If a mobility model is used, the mobility model will override the set
direction, and hence using this method to set a direction is not necessary.
The subclass controlling the direction internally will simply ignore
this call.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>direction</strong><span class="classifier">sim.direction.DIR subclass</span></dt><dd><p>The direction object to use.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.get_displacement">
<code class="sig-name descname">get_displacement</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.get_displacement" title="Permalink to this definition">¶</a></dt>
<dd><p>This method returns the displacement of the node in the
last simulation time step. The displacement is useful to calculate
the actual speed of a node.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><dl class="simple">
<dt>float</dt><dd><p>The displacement of the node in the last simulation time step.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.pause">
<code class="sig-name descname">pause</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pause_flag</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.pause" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply a pause to the movement of the node, or resume the movement
from a pause.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pause_flag</strong><span class="classifier">bool, optional, default=True</span></dt><dd><p>Specify whether the movement of the node should be paused or
resumed from a pause.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.is_pause">
<code class="sig-name descname">is_pause</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.is_pause" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the movement of the node is paused.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><dl class="simple">
<dt>bool</dt><dd><p>It returns if the movement of the node is paused.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.BaseMobility.get_node">
<code class="sig-name descname">get_node</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.BaseMobility.get_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the node that uses this mobility instance.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><dl class="simple">
<dt><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> subclass</dt><dd><p>It returns the node that uses this mobility.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="node.mobility.Stationary">
<em class="property">class </em><code class="sig-prename descclassname">node.mobility.</code><code class="sig-name descname">Stationary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">location</span></em>, <em class="sig-param"><span class="n">direction</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.Stationary" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#node.mobility.BaseMobility" title="node.mobility.BaseMobility"><code class="xref py py-class docutils literal notranslate"><span class="pre">node.mobility.BaseMobility</span></code></a></p>
<p>This class provides a specification of a static location for a
non-moving node to use.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>location</strong><span class="classifier">sim.loc.LOC subclass</span></dt><dd><p>The node that has this mobility.</p>
</dd>
<dt><strong>direction</strong><span class="classifier">sim.direction.DIR subclass, optional, default=None</span></dt><dd><p>The current direction. If <cite>None</cite> is used, it has the same behavior as
sim.direction.NorthDir object.</p>
</dd>
</dl>
</dd>
</dl>
<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><a class="reference internal" href="#node.mobility.Stationary.get_dir" title="node.mobility.Stationary.get_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_dir</span></code></a>()</p></td>
<td><p>See the base class for details.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_displacement</span></code>()</p></td>
<td><p>This method returns the displacement of the node in the last simulation time step.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.Stationary.get_loc" title="node.mobility.Stationary.get_loc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_loc</span></code></a>()</p></td>
<td><p>See the base class for details.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.Stationary.get_name" title="node.mobility.Stationary.get_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name</span></code></a>()</p></td>
<td><p>Call this method to get the name of this class.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_node</span></code>()</p></td>
<td><p>Get the node that uses this mobility instance.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.Stationary.get_speed" title="node.mobility.Stationary.get_speed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_speed</span></code></a>()</p></td>
<td><p>See the base class for details.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_pause</span></code>()</p></td>
<td><p>Check if the movement of the node is paused.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">pause</span></code>([pause_flag])</p></td>
<td><p>Apply a pause to the movement of the node, or resume the movement from a pause.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.Stationary.set_dir" title="node.mobility.Stationary.set_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_dir</span></code></a>(direction)</p></td>
<td><p>This is a stationary class, thus explicitly setting a direction is needed.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.Stationary.sim__do_move" title="node.mobility.Stationary.sim__do_move"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sim__do_move</span></code></a>(time_step)</p></td>
<td><p>This is a stationary mobility class, so calling this method does nothing.</p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="node.mobility.Stationary.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">location</span></em>, <em class="sig-param"><span class="n">direction</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.Stationary.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the constructor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>location</strong><span class="classifier">sim.loc.LOC subclass</span></dt><dd><p>The node that has this mobility.</p>
</dd>
<dt><strong>direction</strong><span class="classifier">sim.direction.DIR subclass, optional, default=None</span></dt><dd><p>The current direction. If <cite>None</cite> is used, it has the same behavior as
sim.direction.NorthDir object.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.Stationary.get_name">
<code class="sig-name descname">get_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.Stationary.get_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this method to get the name of this class.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.Stationary.sim__do_move">
<code class="sig-name descname">sim__do_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">time_step</span></em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#node.mobility.Stationary.sim__do_move" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a stationary mobility class, so calling this method
does nothing. See also the base class for details.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.Stationary.get_loc">
<code class="sig-name descname">get_loc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.Stationary.get_loc" title="Permalink to this definition">¶</a></dt>
<dd><p>See the base class for details.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.Stationary.get_speed">
<code class="sig-name descname">get_speed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.Stationary.get_speed" title="Permalink to this definition">¶</a></dt>
<dd><p>See the base class for details.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.Stationary.get_dir">
<code class="sig-name descname">get_dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.Stationary.get_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>See the base class for details.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.Stationary.set_dir">
<code class="sig-name descname">set_dir</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">direction</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.Stationary.set_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a stationary class, thus explicitly setting a direction
is needed. If not, <cite>None</cite> is used which has the same behaviour of
a north pointing direction.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>direction</strong><span class="classifier">sim.direction.DIR subclass</span></dt><dd><p>Provide a direction instance to describe the pointing direction.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="node.mobility.StaticPath">
<em class="property">class </em><code class="sig-prename descclassname">node.mobility.</code><code class="sig-name descname">StaticPath</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">start_loc</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">[]</span></em>, <em class="sig-param"><span class="n">delay_start</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#node.mobility.BaseMobility" title="node.mobility.BaseMobility"><code class="xref py py-class docutils literal notranslate"><span class="pre">node.mobility.BaseMobility</span></code></a></p>
<p>This class provides a specification of a static path for a
node to move statically along the defined path independent to other
vehicles.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>start_loc</strong><span class="classifier"><a class="reference internal" href="sim.loc.html#sim.loc.LOC" title="sim.loc.LOC"><code class="xref py py-class docutils literal notranslate"><span class="pre">sim.loc.LOC</span></code></a> subclass</span></dt><dd><p>The starting location.</p>
</dd>
<dt><strong>path</strong><span class="classifier">a list of (speed,location) tuple</span></dt><dd><p>The list containing a series of speed-location pairs describing
the movement. From the previous location (or <cite>start_loc</cite>), the node moves
to the next <cite>location</cite> with <cite>speed</cite> based on the current tuple.</p>
</dd>
<dt><strong>delay_start</strong><span class="classifier">float</span></dt><dd><p>Apply a delay start to the mobility based on this input</p>
</dd>
</dl>
</dd>
</dl>
<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><a class="reference internal" href="#node.mobility.StaticPath.add_path" title="node.mobility.StaticPath.add_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_path</span></code></a>(speed, loc)</p></td>
<td><p>Use this method to append a new path to the path list.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.StaticPath.get_dir" title="node.mobility.StaticPath.get_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_dir</span></code></a>()</p></td>
<td><p>See the base class for details.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_displacement</span></code>()</p></td>
<td><p>This method returns the displacement of the node in the last simulation time step.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.StaticPath.get_loc" title="node.mobility.StaticPath.get_loc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_loc</span></code></a>()</p></td>
<td><p>See the base class for details.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.StaticPath.get_name" title="node.mobility.StaticPath.get_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_name</span></code></a>()</p></td>
<td><p>Call this method to get the name of this class.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_node</span></code>()</p></td>
<td><p>Get the node that uses this mobility instance.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.StaticPath.get_speed" title="node.mobility.StaticPath.get_speed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_speed</span></code></a>()</p></td>
<td><p>See the base class for details.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_pause</span></code>()</p></td>
<td><p>Check if the movement of the node is paused.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">pause</span></code>([pause_flag])</p></td>
<td><p>Apply a pause to the movement of the node, or resume the movement from a pause.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.StaticPath.reset_path" title="node.mobility.StaticPath.reset_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reset_path</span></code></a>(speed, loc[, delay_start])</p></td>
<td><p>Use this method to clear all existing paths and add a new path without changing the current location.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.StaticPath.restart" title="node.mobility.StaticPath.restart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">restart</span></code></a>([delay_start])</p></td>
<td><p>Use this method to restart the mobility.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#node.mobility.StaticPath.set_dir" title="node.mobility.StaticPath.set_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_dir</span></code></a>(direction)</p></td>
<td><p>The method in this class will not do anything, since the direction is calculated automatically based on the moving direction.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#node.mobility.StaticPath.sim__do_move" title="node.mobility.StaticPath.sim__do_move"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sim__do_move</span></code></a>(time_step)</p></td>
<td><p>This method is used within the simulation engine, not for user simulation.</p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="node.mobility.StaticPath.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">start_loc</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">[]</span></em>, <em class="sig-param"><span class="n">delay_start</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the constructor.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>start_loc</strong><span class="classifier"><a class="reference internal" href="sim.loc.html#sim.loc.LOC" title="sim.loc.LOC"><code class="xref py py-class docutils literal notranslate"><span class="pre">sim.loc.LOC</span></code></a> subclass</span></dt><dd><p>The starting location.</p>
</dd>
<dt><strong>path</strong><span class="classifier">a list of (speed,location) tuple</span></dt><dd><p>The list containing a series of speed-location pairs describing
the movement.</p>
</dd>
<dt><strong>delay_start</strong><span class="classifier">float</span></dt><dd><p>Apply a delay start to the mobility based on this input</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.get_name">
<code class="sig-name descname">get_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.get_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this method to get the name of this class.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.add_path">
<code class="sig-name descname">add_path</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">speed</span></em>, <em class="sig-param"><span class="n">loc</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.add_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Use this method to append a new path to the path list. When a node
has completed all its movements, use this method to add a new path
for the node to start moving again.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>speed</strong><span class="classifier">float</span></dt><dd><p>The speed of the new path</p>
</dd>
<dt><strong>loc</strong><span class="classifier">sim.loc.LOC subclass</span></dt><dd><p>The end point of the new path</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.restart">
<code class="sig-name descname">restart</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">delay_start</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.restart" title="Permalink to this definition">¶</a></dt>
<dd><p>Use this method to restart the mobility.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.reset_path">
<code class="sig-name descname">reset_path</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">speed</span></em>, <em class="sig-param"><span class="n">loc</span></em>, <em class="sig-param"><span class="n">delay_start</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.reset_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Use this method to clear all existing paths and add a new path without
changing the current location. The node will forget all the past movement
and start moving based on the new path from its current location.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>speed</strong><span class="classifier">float</span></dt><dd><p>The speed of the new path.</p>
</dd>
<dt><strong>loc</strong><span class="classifier"><a class="reference internal" href="sim.loc.html#sim.loc.LOC" title="sim.loc.LOC"><code class="xref py py-class docutils literal notranslate"><span class="pre">sim.loc.LOC</span></code></a> subclass</span></dt><dd><p>The end point of the new path.</p>
</dd>
<dt><strong>delay_start</strong><span class="classifier">float</span></dt><dd><p>Apply a delay start to the mobility based on this input.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.sim__do_move">
<code class="sig-name descname">sim__do_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">time_step</span></em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#node.mobility.StaticPath.sim__do_move" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used within the simulation engine, not for user simulation.
This method to used by the simulation engine to make this node to move
over a <cite>time_step</cite>. See the base class for details.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>time_step</strong><span class="classifier">float</span></dt><dd><p>The time to move forward to (in seconds).</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>boolean</dt><dd><p>Whether the mobility has reached an end. It always returns <cite>False</cite>
when the movement is paused.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.get_speed">
<code class="sig-name descname">get_speed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.get_speed" title="Permalink to this definition">¶</a></dt>
<dd><p>See the base class for details.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.get_loc">
<code class="sig-name descname">get_loc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.get_loc" title="Permalink to this definition">¶</a></dt>
<dd><p>See the base class for details.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.set_dir">
<code class="sig-name descname">set_dir</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">direction</span></em><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.set_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The method in this class will not do anything, since the direction
is calculated automatically based on the moving direction.</p>
</dd></dl>
<dl class="py method">
<dt id="node.mobility.StaticPath.get_dir">
<code class="sig-name descname">get_dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#node.mobility.StaticPath.get_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>See the base class for details.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</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>