blob: 937b830e52d3c10910167914998e665921254481 (
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
|
<!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: OsclTickCount 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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>OsclTickCount Class Reference<br/>
<small>
[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
</h1><!-- doxytag: class="OsclTickCount" -->
<p><code>#include <<a class="el" href="oscl__tickcount_8h_source.html">oscl_tickcount.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTickCount.html#a5c90adc733b66009942f02b03d26e04c">TickCount</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTickCount.html#af496cdf797c653bc310964ef5518d776">TickCountFrequency</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTickCount.html#a52e4f39f3d189828e241ef9bf78619c9">TickCountPeriod</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTickCount.html#a2a1011925df5b0f83f61138821bd262d">TicksToMsec</a> (uint32 ticks)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTickCount.html#a4c0e7c33363720fe39c2683830ae5d01">MsecToTicks</a> (uint32 msec)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classOsclTickCount.html">OsclTickCount</a> class is used to retrieve the system tick count and the tick counter's frequency.</p>
<p>The maximum tick count value is equivalent to the maximum uint32 value. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4c0e7c33363720fe39c2683830ae5d01"></a><!-- doxytag: member="OsclTickCount::MsecToTicks" ref="a4c0e7c33363720fe39c2683830ae5d01" args="(uint32 msec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static uint32 OsclTickCount::MsecToTicks </td>
<td>(</td>
<td class="paramtype">uint32 </td>
<td class="paramname"> <em>msec</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function converts milliseconds to ticks</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>ticks </dd></dl>
</div>
</div>
<a class="anchor" id="a5c90adc733b66009942f02b03d26e04c"></a><!-- doxytag: member="OsclTickCount::TickCount" ref="a5c90adc733b66009942f02b03d26e04c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static uint32 OsclTickCount::TickCount </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the current system tick count</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>returns the tick count </dd></dl>
<p>Referenced by <a class="el" href="oscl__timer_8h_source.html#l00253">OsclTimer< Alloc >::Request()</a>, and <a class="el" href="oscl__timer_8h_source.html#l00329">OsclTimer< Alloc >::TimerBaseElapsed()</a>.</p>
</div>
</div>
<a class="anchor" id="af496cdf797c653bc310964ef5518d776"></a><!-- doxytag: member="OsclTickCount::TickCountFrequency" ref="af496cdf797c653bc310964ef5518d776" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static uint32 OsclTickCount::TickCountFrequency </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the tick frequency in ticks per second</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>ticks per second </dd></dl>
</div>
</div>
<a class="anchor" id="a52e4f39f3d189828e241ef9bf78619c9"></a><!-- doxytag: member="OsclTickCount::TickCountPeriod" ref="a52e4f39f3d189828e241ef9bf78619c9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static uint32 OsclTickCount::TickCountPeriod </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the tick period in microseconds per tick</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>microseconds per tick </dd></dl>
<p>Referenced by <a class="el" href="oscl__timer_8h_source.html#l00243">OsclTimer< Alloc >::SetExactFrequency()</a>, and <a class="el" href="oscl__timer_8h_source.html#l00234">OsclTimer< Alloc >::SetFrequency()</a>.</p>
</div>
</div>
<a class="anchor" id="a2a1011925df5b0f83f61138821bd262d"></a><!-- doxytag: member="OsclTickCount::TicksToMsec" ref="a2a1011925df5b0f83f61138821bd262d" args="(uint32 ticks)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static uint32 OsclTickCount::TicksToMsec </td>
<td>(</td>
<td class="paramtype">uint32 </td>
<td class="paramname"> <em>ticks</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function converts ticks to milliseconds</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>milliseconds </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__tickcount_8h_source.html">oscl_tickcount.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.004.1.1 </small>
</small></address>
</body>
</html>
|
