aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/classNTPTime.html
blob: 04ab9a012e5edc43e8e096645071151addc4fb23 (plain)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>oscl: NTPTime Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>NTPTime Class Reference<br/>
<small>
[<a class="el" href="group__osclbase.html">OSCL Base</a>]</small>
</h1><!-- doxytag: class="NTPTime" -->
<p>The <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> class represents a time value as the number of seconds since 0h (UTC) Jan. 1, 1900.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="oscl__time_8h_source.html">oscl_time.h</a>&gt;</code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#ac2206e5d0d4b8437927a34a402c9dcd9">NTPTime</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default constructor creates an <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> instance representing the current system time.  <a href="#ac2206e5d0d4b8437927a34a402c9dcd9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a94956f9ce1bc89d3f4ba8f5c6027d5af">NTPTime</a> (const <a class="el" href="classNTPTime.html">NTPTime</a> &amp;src)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor to create a new <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> from an existing one.  <a href="#a94956f9ce1bc89d3f4ba8f5c6027d5af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#aeb6f42c5078772a3d98496961f825e49">NTPTime</a> (const uint32 seconds)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct an <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> from a uint32.  <a href="#aeb6f42c5078772a3d98496961f825e49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a5b1b24e9a0a5c447846d745adce3ddf6">NTPTime</a> (const int32 seconds)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct an <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> from a int.  <a href="#a5b1b24e9a0a5c447846d745adce3ddf6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a71f5c062e665ed06a9785709ee947388">NTPTime</a> (const <a class="el" href="classTimeValue.html">TimeValue</a> &amp;t)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> instance from a <a class="el" href="classTimeValue.html" title="The TimeValue class represents a time value in a format native to the system.">TimeValue</a> instance.  <a href="#a71f5c062e665ed06a9785709ee947388"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a7a93fecb8ae21fec3158f9ad8753db09">NTPTime</a> (const <a class="el" href="group__osclbase.html#gaeee93fd1c6230965ea7adc3e63fac06e">uint64</a> value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> instance from a uint64 value.  <a href="#a7a93fecb8ae21fec3158f9ad8753db09"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF <a class="el" href="classNTPTime.html">NTPTime</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a153ed1e46aa9df669c9e70cdbd02bc79">operator=</a> (uint32 newval)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The assignment operator for a 32 bit integer.  <a href="#a153ed1e46aa9df669c9e70cdbd02bc79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF <a class="el" href="classNTPTime.html">NTPTime</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#abc3b7c42f40ee467a0df4b285e4153b7">operator=</a> (<a class="el" href="group__osclbase.html#gaeee93fd1c6230965ea7adc3e63fac06e">uint64</a> newval)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The assignment operator for a 64 bit integer.  <a href="#abc3b7c42f40ee467a0df4b285e4153b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF <a class="el" href="classNTPTime.html">NTPTime</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a493c5d8d1aa6c7e3defaf2edd800755e">operator+=</a> (<a class="el" href="group__osclbase.html#gaeee93fd1c6230965ea7adc3e63fac06e">uint64</a> val)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The += operator is used to add a 64 bit 32.32 value to an existing <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> value.  <a href="#a493c5d8d1aa6c7e3defaf2edd800755e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF <a class="el" href="classNTPTime.html">NTPTime</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#af049db14fcdbcd3f4725f0d533a27e3a">operator-</a> (const <a class="el" href="classNTPTime.html">NTPTime</a> &amp;ntpt) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The - operator allows subtraction of one <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> value from another. This is useful to measure an interval.  <a href="#af049db14fcdbcd3f4725f0d533a27e3a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a0b1341989092b4fe016013f77abc5769">set_from_system_time</a> (const uint32 systemtime)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method converts a 32-bit system time to NTP time.  <a href="#a0b1341989092b4fe016013f77abc5769"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a3765acf50e6ac18766314f1d34019533">get_middle32</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Grab the middle 32 bits of the 64 bit 32.32 representation.  <a href="#a3765acf50e6ac18766314f1d34019533"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a797bddc83fc4eddea410dbc9aa58bad2">get_upper32</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the upper 32 bits of the 32.32 representation.  <a href="#a797bddc83fc4eddea410dbc9aa58bad2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a1891c1c537f39ba827ca2052b4194d08">get_lower32</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the lower 32 bits of the 32.32 representation.  <a href="#a1891c1c537f39ba827ca2052b4194d08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#ae504bc724ab796f308a4c79f5b1a2b34">to_system_time</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method converts the ntp time value to system time.  <a href="#ae504bc724ab796f308a4c79f5b1a2b34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF <a class="el" href="group__osclbase.html#gaeee93fd1c6230965ea7adc3e63fac06e">uint64</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#a61b734a583082af44f2211a852d43d89">get_value</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the 32.32 ntp representation.  <a href="#a61b734a583082af44f2211a852d43d89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNTPTime.html#af5aa35c19c56546e5ae7bd50568d07d7">set_to_current_time</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method sets the 32.32 representation to the current system time value.  <a href="#af5aa35c19c56546e5ae7bd50568d07d7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> class represents a time value as the number of seconds since 0h (UTC) Jan. 1, 1900. </p>
<p>The <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> class: Conversion to/from Unix (epoch at 0h Jan. 1, 1970) amount to addition/subtraction of 2208988800. A single 64 bit value is used to represent the time. This value represents the number of seconds since 0h (UTC) Jan. 1, 1900. There is an implied binary point betweeen the upper 32 bits and lower 32 bits (this is referred to as a 32.32 fractional representation). For example a binary value of 00000000 00000000 00000000 00000011 10000000 00000000 00000000 00000000 represents 3.5 seconds since Jan 1, 1900. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac2206e5d0d4b8437927a34a402c9dcd9"></a><!-- doxytag: member="NTPTime::NTPTime" ref="ac2206e5d0d4b8437927a34a402c9dcd9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF NTPTime::NTPTime </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The default constructor creates an <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> instance representing the current system time. </p>

</div>
</div>
<a class="anchor" id="a94956f9ce1bc89d3f4ba8f5c6027d5af"></a><!-- doxytag: member="NTPTime::NTPTime" ref="a94956f9ce1bc89d3f4ba8f5c6027d5af" args="(const NTPTime &amp;src)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF NTPTime::NTPTime </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classNTPTime.html">NTPTime</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>src</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Copy constructor to create a new <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> from an existing one. </p>

</div>
</div>
<a class="anchor" id="aeb6f42c5078772a3d98496961f825e49"></a><!-- doxytag: member="NTPTime::NTPTime" ref="aeb6f42c5078772a3d98496961f825e49" args="(const uint32 seconds)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF NTPTime::NTPTime </td>
          <td>(</td>
          <td class="paramtype">const uint32&nbsp;</td>
          <td class="paramname"> <em>seconds</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct an <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> from a uint32. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>seconds</em>&nbsp;</td><td>The uint32 input represents the number of seconds since Jan. 1, 1900. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5b1b24e9a0a5c447846d745adce3ddf6"></a><!-- doxytag: member="NTPTime::NTPTime" ref="a5b1b24e9a0a5c447846d745adce3ddf6" args="(const int32 seconds)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF NTPTime::NTPTime </td>
          <td>(</td>
          <td class="paramtype">const int32&nbsp;</td>
          <td class="paramname"> <em>seconds</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct an <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> from a int. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>seconds</em>&nbsp;</td><td>The int input represents the number of seconds since Jan. 1, 1900. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a71f5c062e665ed06a9785709ee947388"></a><!-- doxytag: member="NTPTime::NTPTime" ref="a71f5c062e665ed06a9785709ee947388" args="(const TimeValue &amp;t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF NTPTime::NTPTime </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTimeValue.html">TimeValue</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>t</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct a <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> instance from a <a class="el" href="classTimeValue.html" title="The TimeValue class represents a time value in a format native to the system.">TimeValue</a> instance. </p>
<p>This constructor creates an <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> value representing the same absolute time as the <a class="el" href="classTimeValue.html" title="The TimeValue class represents a time value in a format native to the system.">TimeValue</a> parameter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>t</em>&nbsp;</td><td>A reference to a <a class="el" href="classTimeValue.html" title="The TimeValue class represents a time value in a format native to the system.">TimeValue</a> object. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a7a93fecb8ae21fec3158f9ad8753db09"></a><!-- doxytag: member="NTPTime::NTPTime" ref="a7a93fecb8ae21fec3158f9ad8753db09" args="(const uint64 value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF NTPTime::NTPTime </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__osclbase.html#gaeee93fd1c6230965ea7adc3e63fac06e">uint64</a>&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct a <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> instance from a uint64 value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>A 64 bit integer argument which is used as the ntp 32.32 fractional representation. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1891c1c537f39ba827ca2052b4194d08"></a><!-- doxytag: member="NTPTime::get_lower32" ref="a1891c1c537f39ba827ca2052b4194d08" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF uint32 NTPTime::get_lower32 </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This method returns the lower 32 bits of the 32.32 representation. </p>

</div>
</div>
<a class="anchor" id="a3765acf50e6ac18766314f1d34019533"></a><!-- doxytag: member="NTPTime::get_middle32" ref="a3765acf50e6ac18766314f1d34019533" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF uint32 NTPTime::get_middle32 </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Grab the middle 32 bits of the 64 bit 32.32 representation. </p>

</div>
</div>
<a class="anchor" id="a797bddc83fc4eddea410dbc9aa58bad2"></a><!-- doxytag: member="NTPTime::get_upper32" ref="a797bddc83fc4eddea410dbc9aa58bad2" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF uint32 NTPTime::get_upper32 </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This method returns the upper 32 bits of the 32.32 representation. </p>

</div>
</div>
<a class="anchor" id="a61b734a583082af44f2211a852d43d89"></a><!-- doxytag: member="NTPTime::get_value" ref="a61b734a583082af44f2211a852d43d89" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF <a class="el" href="group__osclbase.html#gaeee93fd1c6230965ea7adc3e63fac06e">uint64</a> NTPTime::get_value </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This method returns the 32.32 ntp representation. </p>

</div>
</div>
<a class="anchor" id="a493c5d8d1aa6c7e3defaf2edd800755e"></a><!-- doxytag: member="NTPTime::operator+=" ref="a493c5d8d1aa6c7e3defaf2edd800755e" args="(uint64 val)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF <a class="el" href="classNTPTime.html">NTPTime</a>&amp; NTPTime::operator+= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__osclbase.html#gaeee93fd1c6230965ea7adc3e63fac06e">uint64</a>&nbsp;</td>
          <td class="paramname"> <em>val</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The += operator is used to add a 64 bit 32.32 value to an existing <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The 64 bit 32.32 value to add to this object's value. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af049db14fcdbcd3f4725f0d533a27e3a"></a><!-- doxytag: member="NTPTime::operator&#45;" ref="af049db14fcdbcd3f4725f0d533a27e3a" args="(const NTPTime &amp;ntpt) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF <a class="el" href="classNTPTime.html">NTPTime</a> NTPTime::operator- </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classNTPTime.html">NTPTime</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ntpt</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The - operator allows subtraction of one <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> value from another. This is useful to measure an interval. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ntpt</em>&nbsp;</td><td>A reference to the <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> object to be subracted from this one. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="abc3b7c42f40ee467a0df4b285e4153b7"></a><!-- doxytag: member="NTPTime::operator=" ref="abc3b7c42f40ee467a0df4b285e4153b7" args="(uint64 newval)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF <a class="el" href="classNTPTime.html">NTPTime</a>&amp; NTPTime::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__osclbase.html#gaeee93fd1c6230965ea7adc3e63fac06e">uint64</a>&nbsp;</td>
          <td class="paramname"> <em>newval</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The assignment operator for a 64 bit integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>newval</em>&nbsp;</td><td>A 64 bit value which represents the 32.32 fractional representation of the ntp time. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a153ed1e46aa9df669c9e70cdbd02bc79"></a><!-- doxytag: member="NTPTime::operator=" ref="a153ed1e46aa9df669c9e70cdbd02bc79" args="(uint32 newval)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_COND_IMPORT_REF <a class="el" href="classNTPTime.html">NTPTime</a>&amp; NTPTime::operator= </td>
          <td>(</td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>newval</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The assignment operator for a 32 bit integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>newval</em>&nbsp;</td><td>A 32 bit integer representing the upper 32 bits of the 32.32 NTP time (e.g. the number of whole seconds since Jan 1, 1900 UTC). </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a0b1341989092b4fe016013f77abc5769"></a><!-- doxytag: member="NTPTime::set_from_system_time" ref="a0b1341989092b4fe016013f77abc5769" args="(const uint32 systemtime)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void NTPTime::set_from_system_time </td>
          <td>(</td>
          <td class="paramtype">const uint32&nbsp;</td>
          <td class="paramname"> <em>systemtime</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This method converts a 32-bit system time to NTP time. </p>
<p>This method sets the value of the <a class="el" href="classNTPTime.html" title="The NTPTime class represents a time value as the number of seconds since 0h (UTC)...">NTPTime</a> instance to the absolute time represented by the 32 bit input argument. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>systemtime</em>&nbsp;</td><td>This 32-bit value is interpreted as the number of seconds since the unix epoch Jan. 1 1970. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af5aa35c19c56546e5ae7bd50568d07d7"></a><!-- doxytag: member="NTPTime::set_to_current_time" ref="af5aa35c19c56546e5ae7bd50568d07d7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF int NTPTime::set_to_current_time </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This method sets the 32.32 representation to the current system time value. </p>

</div>
</div>
<a class="anchor" id="ae504bc724ab796f308a4c79f5b1a2b34"></a><!-- doxytag: member="NTPTime::to_system_time" ref="ae504bc724ab796f308a4c79f5b1a2b34" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32 NTPTime::to_system_time </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This method converts the ntp time value to system time. </p>
<p>This method returns a 32 bit value representing the same absolute time as the NTP time value, but expressed as whole seconds since the unix epoch. The fractional part of the ntp value is discarded. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__time_8h_source.html">oscl_time.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.002.1.1 </small>
</small></address>
</body>
</html>