-
Notifications
You must be signed in to change notification settings - Fork 0
/
sim.simsystem.html
334 lines (257 loc) · 10.8 KB
/
sim.simsystem.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>sim.simsystem 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="sim.simulation module" href="sim.simulation.html" />
<link rel="prev" title="sim.scenario module" href="sim.scenario.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 current active 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="sim.direction.html">
sim.direction module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="sim.drawable.html">
sim.drawable module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="sim.event.html">
sim.event module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="sim.frame.html">
sim.frame module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="sim.loc.html">
sim.loc module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="sim.scenario.html">
sim.scenario module
</a>
</li>
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
sim.simsystem module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="sim.simulation.html">
sim.simulation module
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="sim.version.html">
sim.version module
</a>
</li>
</ul>
</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-sim.simsystem">
<span id="sim-simsystem-module"></span><h1>sim.simsystem module<a class="headerlink" href="#module-sim.simsystem" title="Permalink to this headline">¶</a></h1>
<p>This module provides <cite>SimSystem</cite> class which is used for simulation
system control. <cite>SimSystem</cite> is a static class, it should be called
directly without an instance. It is used for other internal
modules to do the following:</p>
<ul class="simple">
<li><p>reporting simulation warning due to incorrect implementation</p></li>
<li><p>stopping simulation due to a critical error</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<dl class="simple">
<dt>SimSystem.err(err_str)</dt><dd><p>Call this function when a fatal error has occurred.
Calling this function will stop the running and report
the provided error message.</p>
</dd>
<dt>SimSystem.warn(warn_str)</dt><dd><p>Call this function when a non-critical situation has
occurred. Calling this function will show a warning on
the terminal but will not stop the running.</p>
</dd>
</dl>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>Created by: CH Foh (2021)</p></li>
</ul>
</div>
<dl class="py class">
<dt id="sim.simsystem.SimSystem">
<em class="property">class </em><code class="sig-prename descclassname">sim.simsystem.</code><code class="sig-name descname">SimSystem</code><a class="headerlink" href="#sim.simsystem.SimSystem" 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>It is a <cite>static</cite> simulation system control class which is
used for others to throw warning or error. Warning will not stop the
simulation but error will stop the running immediately.</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="#sim.simsystem.SimSystem.err" title="sim.simsystem.SimSystem.err"><code class="xref py py-obj docutils literal notranslate"><span class="pre">err</span></code></a>(err_str)</p></td>
<td><p>Throw an error message and stop the running.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#sim.simsystem.SimSystem.warn" title="sim.simsystem.SimSystem.warn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">warn</span></code></a>(warn_str)</p></td>
<td><p>Throw a warning message.</p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="sim.simsystem.SimSystem.err">
<em class="property">static </em><code class="sig-name descname">err</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">err_str</span></em><span class="sig-paren">)</span><a class="headerlink" href="#sim.simsystem.SimSystem.err" title="Permalink to this definition">¶</a></dt>
<dd><p>Throw an error message and stop the running.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>err_str</strong><span class="classifier">str</span></dt><dd><p>The error message to show on the terminal.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="sim.simsystem.SimSystem.warn">
<em class="property">static </em><code class="sig-name descname">warn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">warn_str</span></em><span class="sig-paren">)</span><a class="headerlink" href="#sim.simsystem.SimSystem.warn" title="Permalink to this definition">¶</a></dt>
<dd><p>Throw a warning message.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>warn_str</strong><span class="classifier">str</span></dt><dd><p>The warning message to show on the terminal.</p>
</dd>
</dl>
</dd>
</dl>
</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>