-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasshopsan_1_1DelayTemplate.html
More file actions
401 lines (375 loc) · 19.3 KB
/
Copy pathclasshopsan_1_1DelayTemplate.html
File metadata and controls
401 lines (375 loc) · 19.3 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
<!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>Hopsan: DelayTemplate< T > Class Template 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hopsan.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">Hopsan
</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 */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('classhopsan_1_1DelayTemplate.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhopsan_1_1DelayTemplate-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DelayTemplate< T > Class Template Reference<div class="ingroups"><a class="el" href="group__ComponentUtilities.html">ComponentUtilities</a> » <a class="el" href="group__ComponentUtilityClasses.html">ComponentUtilityClasses</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Delay template class, implementing a circular buffer containing values of specified type.
<a href="#details">More...</a></p>
<p><code>#include <Delay.hpp></code></p>
<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:a0553e13d21f0b3df9f96fcceb48de407" id="r_a0553e13d21f0b3df9f96fcceb48de407"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0553e13d21f0b3df9f96fcceb48de407">initialize</a> (const double timeDelay, const double Ts, const T initValue)</td></tr>
<tr class="memdesc:a0553e13d21f0b3df9f96fcceb48de407"><td class="mdescLeft"> </td><td class="mdescRight">Initialize delay buffer size based on timeDelay and timestep, Td/Ts must be multiple of 1 and >= 1. <br /></td></tr>
<tr class="separator:a0553e13d21f0b3df9f96fcceb48de407"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6af65070c5fe93fc5fde2a4fb1318152" id="r_a6af65070c5fe93fc5fde2a4fb1318152"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6af65070c5fe93fc5fde2a4fb1318152">initialize</a> (const int delaySteps, const T initValue)</td></tr>
<tr class="memdesc:a6af65070c5fe93fc5fde2a4fb1318152"><td class="mdescLeft"> </td><td class="mdescRight">Initialize delay size based on known number of delay steps. <br /></td></tr>
<tr class="separator:a6af65070c5fe93fc5fde2a4fb1318152"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb7593a89507fd019c0515d12c7876c6" id="r_acb7593a89507fd019c0515d12c7876c6"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="#acb7593a89507fd019c0515d12c7876c6">update</a> (const T newValue)</td></tr>
<tr class="memdesc:acb7593a89507fd019c0515d12c7876c6"><td class="mdescLeft"> </td><td class="mdescRight">Updates delay with a new value, "pop old", "push new". You should likely run this at the end of each time step. <br /></td></tr>
<tr class="separator:acb7593a89507fd019c0515d12c7876c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac55d9d6db9f26cc210b9f402e6b163e0" id="r_ac55d9d6db9f26cc210b9f402e6b163e0"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac55d9d6db9f26cc210b9f402e6b163e0">getOldest</a> () const</td></tr>
<tr class="memdesc:ac55d9d6db9f26cc210b9f402e6b163e0"><td class="mdescLeft"> </td><td class="mdescRight">Get the oldest value in the buffer. <br /></td></tr>
<tr class="separator:ac55d9d6db9f26cc210b9f402e6b163e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6be79212507d4f90328f282a5bce75dd" id="r_a6be79212507d4f90328f282a5bce75dd"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6be79212507d4f90328f282a5bce75dd">getNewest</a> () const</td></tr>
<tr class="memdesc:a6be79212507d4f90328f282a5bce75dd"><td class="mdescLeft"> </td><td class="mdescRight">Get the newest value in the buffer. <br /></td></tr>
<tr class="separator:a6be79212507d4f90328f282a5bce75dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affb2d44dc85d6261aa5a2bd9a6d27ee2" id="r_affb2d44dc85d6261aa5a2bd9a6d27ee2"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="#affb2d44dc85d6261aa5a2bd9a6d27ee2">getIdx</a> (const size_t i) const</td></tr>
<tr class="memdesc:affb2d44dc85d6261aa5a2bd9a6d27ee2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a specific value, 0=newest, 1=nextnewest, 2=nextnextnewest and so on, no range check is performed. <br /></td></tr>
<tr class="separator:affb2d44dc85d6261aa5a2bd9a6d27ee2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ee5ae36c304384f0a97c5ad6bf65bb9" id="r_a2ee5ae36c304384f0a97c5ad6bf65bb9"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ee5ae36c304384f0a97c5ad6bf65bb9">getOldIdx</a> (const size_t i) const</td></tr>
<tr class="memdesc:a2ee5ae36c304384f0a97c5ad6bf65bb9"><td class="mdescLeft"> </td><td class="mdescRight">Returns a specific value, 0=oldest, 1=nextoldest, 2=nextnextoldest and so on, no range check is performed. <br /></td></tr>
<tr class="separator:a2ee5ae36c304384f0a97c5ad6bf65bb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9be1e4285daa77fe397767c097fbdc66" id="r_a9be1e4285daa77fe397767c097fbdc66"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9be1e4285daa77fe397767c097fbdc66">getSize</a> () const</td></tr>
<tr class="memdesc:a9be1e4285daa77fe397767c097fbdc66"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the delay buffer (the number of buffer elements) <br /></td></tr>
<tr class="separator:a9be1e4285daa77fe397767c097fbdc66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204" id="r_ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top"><a id="ac8bb3912a3ce86b15842e79d0b421204" name="ac8bb3912a3ce86b15842e79d0b421204"></a>
void </td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">Clear the delay buffer, deleting all data. <br /></td></tr>
<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template<typename T><br />
class hopsan::DelayTemplate< T ></div><p>Delay template class, implementing a circular buffer containing values of specified type. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="affb2d44dc85d6261aa5a2bd9a6d27ee2" name="affb2d44dc85d6261aa5a2bd9a6d27ee2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affb2d44dc85d6261aa5a2bd9a6d27ee2">◆ </a></span>getIdx()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T getIdx </td>
<td>(</td>
<td class="paramtype">const size_t</td> <td class="paramname"><span class="paramname"><em>i</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a specific value, 0=newest, 1=nextnewest, 2=nextnextnewest and so on, no range check is performed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>Index of value to return </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Value at specified index </dd></dl>
</div>
</div>
<a id="a6be79212507d4f90328f282a5bce75dd" name="a6be79212507d4f90328f282a5bce75dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6be79212507d4f90328f282a5bce75dd">◆ </a></span>getNewest()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T getNewest </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the newest value in the buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>The newest value in the buffer </dd></dl>
</div>
</div>
<a id="ac55d9d6db9f26cc210b9f402e6b163e0" name="ac55d9d6db9f26cc210b9f402e6b163e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac55d9d6db9f26cc210b9f402e6b163e0">◆ </a></span>getOldest()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T getOldest </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the oldest value in the buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>The oldest value in the buffer </dd></dl>
</div>
</div>
<a id="a2ee5ae36c304384f0a97c5ad6bf65bb9" name="a2ee5ae36c304384f0a97c5ad6bf65bb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ee5ae36c304384f0a97c5ad6bf65bb9">◆ </a></span>getOldIdx()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T getOldIdx </td>
<td>(</td>
<td class="paramtype">const size_t</td> <td class="paramname"><span class="paramname"><em>i</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a specific value, 0=oldest, 1=nextoldest, 2=nextnextoldest and so on, no range check is performed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>Index of value to return </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Value at specified index </dd></dl>
</div>
</div>
<a id="a9be1e4285daa77fe397767c097fbdc66" name="a9be1e4285daa77fe397767c097fbdc66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9be1e4285daa77fe397767c097fbdc66">◆ </a></span>getSize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t getSize </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the size of the delay buffer (the number of buffer elements) </p>
<dl class="section return"><dt>Returns</dt><dd>The size of the delay buffer </dd></dl>
</div>
</div>
<a id="a0553e13d21f0b3df9f96fcceb48de407" name="a0553e13d21f0b3df9f96fcceb48de407"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0553e13d21f0b3df9f96fcceb48de407">◆ </a></span>initialize() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void initialize </td>
<td>(</td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>timeDelay</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>Ts</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T</td> <td class="paramname"><span class="paramname"><em>initValue</em></span> )</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize delay buffer size based on timeDelay and timestep, Td/Ts must be multiple of 1 and >= 1. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timeDelay</td><td>The total time delay for a value to come out on the other side of the circle buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">Ts</td><td>The timestep between each call </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">initValue</td><td>The initial value of all buffer elements </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6af65070c5fe93fc5fde2a4fb1318152" name="a6af65070c5fe93fc5fde2a4fb1318152"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6af65070c5fe93fc5fde2a4fb1318152">◆ </a></span>initialize() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void initialize </td>
<td>(</td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>delaySteps</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T</td> <td class="paramname"><span class="paramname"><em>initValue</em></span> )</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize delay size based on known number of delay steps. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">delaySteps</td><td>The number of delay steps, must be >= 1 </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">initValue</td><td>The initial value of all buffer elements </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acb7593a89507fd019c0515d12c7876c6" name="acb7593a89507fd019c0515d12c7876c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb7593a89507fd019c0515d12c7876c6">◆ </a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T update </td>
<td>(</td>
<td class="paramtype">const T</td> <td class="paramname"><span class="paramname"><em>newValue</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates delay with a new value, "pop old", "push new". You should likely run this at the end of each time step. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">newValue</td><td>The new value to insert into delay buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The oldest value in the delay buffer (After update, this value has been overwritten in the buffer) </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>hopsan</b></li><li class="navelem"><a class="el" href="classhopsan_1_1DelayTemplate.html">DelayTemplate</a></li>
<li class="footer">Generated on Fri Nov 29 2024 14:29:31 for Hopsan 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 </li>
</ul>
</div>
</body>
</html>