-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass_simulations_1_1_simulations.html
311 lines (300 loc) · 14.9 KB
/
class_simulations_1_1_simulations.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SimulFCImage: Simulations.Simulations Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SimulFCImage<span id="projectnumber"> Final</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>Simulations</b></li><li class="navelem"><a class="el" href="class_simulations_1_1_simulations.html">Simulations</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_simulations_1_1_simulations-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Simulations.Simulations Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a88cf8373c191bf766d5f088c7af2316c" id="r_a88cf8373c191bf766d5f088c7af2316c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a88cf8373c191bf766d5f088c7af2316c">__init__</a> (self)</td></tr>
<tr class="separator:a88cf8373c191bf766d5f088c7af2316c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92beddd5512c79b8a9d239079ef0014b" id="r_a92beddd5512c79b8a9d239079ef0014b"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#a92beddd5512c79b8a9d239079ef0014b">add_simulation</a> (self, str name, tuple images)</td></tr>
<tr class="separator:a92beddd5512c79b8a9d239079ef0014b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ecaed876eacd88a1e314d61413ef710" id="r_a8ecaed876eacd88a1e314d61413ef710"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ecaed876eacd88a1e314d61413ef710">delete_simulation</a> (self, str name)</td></tr>
<tr class="separator:a8ecaed876eacd88a1e314d61413ef710"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b8a9fd3b0881eabaa881b3a2a23cb8e" id="r_a6b8a9fd3b0881eabaa881b3a2a23cb8e"><td class="memItemLeft" align="right" valign="top">dict </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b8a9fd3b0881eabaa881b3a2a23cb8e">get_all_datas</a> (self)</td></tr>
<tr class="separator:a6b8a9fd3b0881eabaa881b3a2a23cb8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa50c9982c11db8ef4c705644985fcaf2" id="r_aa50c9982c11db8ef4c705644985fcaf2"><td class="memItemLeft" align="right" valign="top">tuple </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa50c9982c11db8ef4c705644985fcaf2">get_data_by_key</a> (self, str key)</td></tr>
<tr class="separator:aa50c9982c11db8ef4c705644985fcaf2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac59b849b20cd438475ba49f5fd154679" id="r_ac59b849b20cd438475ba49f5fd154679"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac59b849b20cd438475ba49f5fd154679">sort_by_image_name</a> (self)</td></tr>
<tr class="separator:ac59b849b20cd438475ba49f5fd154679"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4380dbf1c4ad8e1bb1a665afa7546a62" id="r_a4380dbf1c4ad8e1bb1a665afa7546a62"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4380dbf1c4ad8e1bb1a665afa7546a62">sort_by_simulation_name</a> (self)</td></tr>
<tr class="separator:a4380dbf1c4ad8e1bb1a665afa7546a62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9782eb35b1c24435e72255f6f2db02d6" id="r_a9782eb35b1c24435e72255f6f2db02d6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9782eb35b1c24435e72255f6f2db02d6">sort_by_date</a> (self)</td></tr>
<tr class="separator:a9782eb35b1c24435e72255f6f2db02d6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">Class Simulations which allow to have an historic of
simulated images
Author : Lakhdar Gibril
</pre> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a88cf8373c191bf766d5f088c7af2316c" name="a88cf8373c191bf766d5f088c7af2316c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88cf8373c191bf766d5f088c7af2316c">◆ </a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Simulations.Simulations.__init__ </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Natural constructor of the class which initialize
a dictionary as a key the simulation name and a tuple of images as a value
Author : Lakhdar Gibril
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a92beddd5512c79b8a9d239079ef0014b" name="a92beddd5512c79b8a9d239079ef0014b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92beddd5512c79b8a9d239079ef0014b">◆ </a></span>add_simulation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None Simulations.Simulations.add_simulation </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tuple</td> <td class="paramname"><span class="paramname"><em>images</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Allow to add a simulated image in the historic.
Args :
- name (str) : the name of the simulation
- images (tuple) : a tuple which contain the original image to display and the simulated one to display
Author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="a8ecaed876eacd88a1e314d61413ef710" name="a8ecaed876eacd88a1e314d61413ef710"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ecaed876eacd88a1e314d61413ef710">◆ </a></span>delete_simulation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None Simulations.Simulations.delete_simulation </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str</td> <td class="paramname"><span class="paramname"><em>name</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Allow to delete a simulated image in the historic by the name
Args :
- name (str) : the name of the simulation to delete
Author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="a6b8a9fd3b0881eabaa881b3a2a23cb8e" name="a6b8a9fd3b0881eabaa881b3a2a23cb8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b8a9fd3b0881eabaa881b3a2a23cb8e">◆ </a></span>get_all_datas()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> dict Simulations.Simulations.get_all_datas </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Getter which allow to only get all the simulations data
</pre>
</div>
</div>
<a id="aa50c9982c11db8ef4c705644985fcaf2" name="aa50c9982c11db8ef4c705644985fcaf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa50c9982c11db8ef4c705644985fcaf2">◆ </a></span>get_data_by_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> tuple Simulations.Simulations.get_data_by_key </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str</td> <td class="paramname"><span class="paramname"><em>key</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Allow to get the key and values of the specified simulated image
Args :
- key (str) : represent the key as a string to get the data, the key represent the simulation name
@return : tuple containing the label of the method, the original image and the simulated image in a tuple
Author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="a9782eb35b1c24435e72255f6f2db02d6" name="a9782eb35b1c24435e72255f6f2db02d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9782eb35b1c24435e72255f6f2db02d6">◆ </a></span>sort_by_date()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Simulations.Simulations.sort_by_date </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Sorts simulations by addition date.
Author : Alexandre Moreau
</pre>
</div>
</div>
<a id="ac59b849b20cd438475ba49f5fd154679" name="ac59b849b20cd438475ba49f5fd154679"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac59b849b20cd438475ba49f5fd154679">◆ </a></span>sort_by_image_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Simulations.Simulations.sort_by_image_name </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Sorts simulations by image name.
Author : Alexandre Moreau
</pre>
</div>
</div>
<a id="a4380dbf1c4ad8e1bb1a665afa7546a62" name="a4380dbf1c4ad8e1bb1a665afa7546a62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4380dbf1c4ad8e1bb1a665afa7546a62">◆ </a></span>sort_by_simulation_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Simulations.Simulations.sort_by_simulation_name </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Sorts simulations by simulation type.
Author : Alexandre Moreau
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>LogicLayer/<b>Simulations.py</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>