-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathstruct_r_t_timespec.html
More file actions
283 lines (267 loc) · 17.2 KB
/
struct_r_t_timespec.html
File metadata and controls
283 lines (267 loc) · 17.2 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
<!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.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>C++ TargetRTS: RTTimespec Struct 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>
<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">C++ TargetRTS
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="struct_r_t_timespec-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">RTTimespec Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A time value which can represent either an absolute or relative time.
<a href="struct_r_t_timespec.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_r_t_timespec_8h_source.html">RTTimespec.h</a>></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:a4da4f3300b82708114753ad15d2f88c3"><td class="memItemLeft" align="right" valign="top"><a id="a4da4f3300b82708114753ad15d2f88c3" name="a4da4f3300b82708114753ad15d2f88c3"></a>
 </td><td class="memItemRight" valign="bottom"><b>RTTimespec</b> (void)</td></tr>
<tr class="memdesc:a4da4f3300b82708114753ad15d2f88c3"><td class="mdescLeft"> </td><td class="mdescRight">Construct a zero time value. <br /></td></tr>
<tr class="separator:a4da4f3300b82708114753ad15d2f88c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac40f489bdb11ccc94fb534444c763c42"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_timespec.html#ac40f489bdb11ccc94fb534444c763c42">RTTimespec</a> (long s, long ns)</td></tr>
<tr class="memdesc:ac40f489bdb11ccc94fb534444c763c42"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new time value. <br /></td></tr>
<tr class="separator:ac40f489bdb11ccc94fb534444c763c42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2113d6b2d607db73f48419616e62cf33"><td class="memItemLeft" align="right" valign="top"><a id="a2113d6b2d607db73f48419616e62cf33" name="a2113d6b2d607db73f48419616e62cf33"></a>
 </td><td class="memItemRight" valign="bottom"><b>RTTimespec</b> (const <a class="el" href="class_r_t_interval.html">RTInterval</a> &)</td></tr>
<tr class="separator:a2113d6b2d607db73f48419616e62cf33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1da3ed5ead0ca8ac897a520354ea477"><td class="memItemLeft" align="right" valign="top"><a id="ad1da3ed5ead0ca8ac897a520354ea477" name="ad1da3ed5ead0ca8ac897a520354ea477"></a>
 </td><td class="memItemRight" valign="bottom"><b>RTTimespec</b> (const <a class="el" href="class_r_t_time.html">RTTime</a> &)</td></tr>
<tr class="separator:ad1da3ed5ead0ca8ac897a520354ea477"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4ea179cba9f680cfcfa99d5c4a24ccd"><td class="memItemLeft" align="right" valign="top"><a id="ab4ea179cba9f680cfcfa99d5c4a24ccd" name="ab4ea179cba9f680cfcfa99d5c4a24ccd"></a>
 </td><td class="memItemRight" valign="bottom"><b>RTTimespec</b> (const <a class="el" href="struct_r_t_timespec.html">RTTimespec</a> &)</td></tr>
<tr class="separator:ab4ea179cba9f680cfcfa99d5c4a24ccd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36a03b18940deeb0f18672763ad2409c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_timespec.html#a36a03b18940deeb0f18672763ad2409c">normalize</a> (void)</td></tr>
<tr class="memdesc:a36a03b18940deeb0f18672763ad2409c"><td class="mdescLeft"> </td><td class="mdescRight">Normalize the time value so that as many seconds as possible are stored in the tv_sec field and remaining nanoseconds in the tv_nsec field. <br /></td></tr>
<tr class="separator:a36a03b18940deeb0f18672763ad2409c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a298c16afe5c2121664476fcba75fb36c"><td class="memItemLeft" align="right" valign="top"><a id="a298c16afe5c2121664476fcba75fb36c" name="a298c16afe5c2121664476fcba75fb36c"></a>
<a class="el" href="struct_r_t_timespec.html">RTTimespec</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="struct_r_t_timespec.html">RTTimespec</a> &)</td></tr>
<tr class="separator:a298c16afe5c2121664476fcba75fb36c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaea65229cface8497166904a42bcccdd"><td class="memItemLeft" align="right" valign="top"><a id="aaea65229cface8497166904a42bcccdd" name="aaea65229cface8497166904a42bcccdd"></a>
<a class="el" href="struct_r_t_timespec.html">RTTimespec</a> & </td><td class="memItemRight" valign="bottom"><b>operator+=</b> (const <a class="el" href="struct_r_t_timespec.html">RTTimespec</a> &)</td></tr>
<tr class="separator:aaea65229cface8497166904a42bcccdd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc6f1425b907763a39ad7ad244082367"><td class="memItemLeft" align="right" valign="top"><a id="acc6f1425b907763a39ad7ad244082367" name="acc6f1425b907763a39ad7ad244082367"></a>
<a class="el" href="struct_r_t_timespec.html">RTTimespec</a> & </td><td class="memItemRight" valign="bottom"><b>operator-=</b> (const <a class="el" href="struct_r_t_timespec.html">RTTimespec</a> &)</td></tr>
<tr class="separator:acc6f1425b907763a39ad7ad244082367"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a822bac82f2a3ff93fd062bc9d264c4"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_timespec.html#a4a822bac82f2a3ff93fd062bc9d264c4">ticksFromNow</a> (long nanoseconds_per_tick) const</td></tr>
<tr class="memdesc:a4a822bac82f2a3ff93fd062bc9d264c4"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of "ticks" which is between this time value and the current time. <br /></td></tr>
<tr class="separator:a4a822bac82f2a3ff93fd062bc9d264c4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aeadd5a948b4fe3784ad1daeeb1e1267d"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_timespec.html#aeadd5a948b4fe3784ad1daeeb1e1267d">getclock</a> (<a class="el" href="struct_r_t_timespec.html">RTTimespec</a> &tspec)</td></tr>
<tr class="memdesc:aeadd5a948b4fe3784ad1daeeb1e1267d"><td class="mdescLeft"> </td><td class="mdescRight">Get the current time. <br /></td></tr>
<tr class="separator:aeadd5a948b4fe3784ad1daeeb1e1267d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3fd562f4b04faef8d12277553da80b95"><td class="memItemLeft" align="right" valign="top"><a id="a3fd562f4b04faef8d12277553da80b95" name="a3fd562f4b04faef8d12277553da80b95"></a>
long </td><td class="memItemRight" valign="bottom"><b>tv_sec</b></td></tr>
<tr class="memdesc:a3fd562f4b04faef8d12277553da80b95"><td class="mdescLeft"> </td><td class="mdescRight">Seconds. <br /></td></tr>
<tr class="separator:a3fd562f4b04faef8d12277553da80b95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a834ddff39b1d6948fb185b791d804832"><td class="memItemLeft" align="right" valign="top"><a id="a834ddff39b1d6948fb185b791d804832" name="a834ddff39b1d6948fb185b791d804832"></a>
long </td><td class="memItemRight" valign="bottom"><b>tv_nsec</b></td></tr>
<tr class="memdesc:a834ddff39b1d6948fb185b791d804832"><td class="mdescLeft"> </td><td class="mdescRight">Nanoseconds. <br /></td></tr>
<tr class="separator:a834ddff39b1d6948fb185b791d804832"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aed8a28be5f241e016ee5df88776217a2"><td class="memItemLeft" align="right" valign="top"><a id="aed8a28be5f241e016ee5df88776217a2" name="aed8a28be5f241e016ee5df88776217a2"></a>
static const <a class="el" href="struct_r_t_timespec.html">RTTimespec</a> </td><td class="memItemRight" valign="bottom"><b>zero</b></td></tr>
<tr class="memdesc:aed8a28be5f241e016ee5df88776217a2"><td class="mdescLeft"> </td><td class="mdescRight">Static constant for a zero time value. <br /></td></tr>
<tr class="separator:aed8a28be5f241e016ee5df88776217a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afaf42e40fe7dda70c9844cc2c53dbe4a"><td class="memItemLeft" align="right" valign="top"><a id="afaf42e40fe7dda70c9844cc2c53dbe4a" name="afaf42e40fe7dda70c9844cc2c53dbe4a"></a>
static const <a class="el" href="struct_r_t_object__class.html">RTObject_class</a> </td><td class="memItemRight" valign="bottom"><b>classData</b></td></tr>
<tr class="memdesc:afaf42e40fe7dda70c9844cc2c53dbe4a"><td class="mdescLeft"> </td><td class="mdescRight">Type descriptor for an <a class="el" href="struct_r_t_timespec.html" title="A time value which can represent either an absolute or relative time.">RTTimespec</a>. <br /></td></tr>
<tr class="separator:afaf42e40fe7dda70c9844cc2c53dbe4a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A time value which can represent either an absolute or relative time. </p>
<p>For an absolute time the representation uses Unix time, i.e. the number of seconds and nanoseconds that have passed since 1 January 1970. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac40f489bdb11ccc94fb534444c763c42" name="ac40f489bdb11ccc94fb534444c763c42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac40f489bdb11ccc94fb534444c763c42">◆ </a></span>RTTimespec()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTTimespec::RTTimespec </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>ns</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new time value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>Number of seconds </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ns</td><td>Number of nanoseconds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aeadd5a948b4fe3784ad1daeeb1e1267d" name="aeadd5a948b4fe3784ad1daeeb1e1267d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeadd5a948b4fe3784ad1daeeb1e1267d">◆ </a></span>getclock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void RTTimespec::getclock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_r_t_timespec.html">RTTimespec</a> & </td>
<td class="paramname"><em>tspec</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">tspec</td><td><a class="el" href="struct_r_t_timespec.html" title="A time value which can represent either an absolute or relative time.">RTTimespec</a> object to write the current time to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a36a03b18940deeb0f18672763ad2409c" name="a36a03b18940deeb0f18672763ad2409c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36a03b18940deeb0f18672763ad2409c">◆ </a></span>normalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTTimespec::normalize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Normalize the time value so that as many seconds as possible are stored in the tv_sec field and remaining nanoseconds in the tv_nsec field. </p>
<p>After calling this function it's guaranteed that tv_nsec < 1000000000. </p>
</div>
</div>
<a id="a4a822bac82f2a3ff93fd062bc9d264c4" name="a4a822bac82f2a3ff93fd062bc9d264c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a822bac82f2a3ff93fd062bc9d264c4">◆ </a></span>ticksFromNow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long RTTimespec::ticksFromNow </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>nanoseconds_per_tick</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of "ticks" which is between this time value and the current time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">nanoseconds_per_tick</td><td>Defines the length of a "tick" in nanoseconds </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of "ticks" until this time value is reached. 0 if this time value is before the current time. </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="_r_t_timespec_8h_source.html">RTTimespec.h</a></li>
<li>RTTimespec.inl</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.9.6
</small></address>
</body>
</html>