• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>OsclTickCount class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5</head><body>
6<!-- Generated by Doxygen 1.2.18 -->
7<center>
8<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
9<hr><h1>OsclTickCount Class Reference<br>
10<small>
11[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
12</h1><code>#include &lt;<a class="el" href="oscl__tickcount_8h-source.html">oscl_tickcount.h</a>&gt;</code>
13<p>
14<table border=0 cellpadding=0 cellspacing=0>
15<tr><td></td></tr>
16<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
17<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclTickCount.html#d0">TickCount</a> ()</td></tr>
18<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclTickCount.html#d1">TickCountFrequency</a> ()</td></tr>
19<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclTickCount.html#d2">TickCountPeriod</a> ()</td></tr>
20<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclTickCount.html#d3">TicksToMsec</a> (uint32 ticks)</td></tr>
21<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclTickCount.html#d4">MsecToTicks</a> (uint32 msec)</td></tr>
22</table>
23<hr><a name="_details"></a><h2>Detailed Description</h2>
24OsclTickCount class is used to retrieve the system tick count and the tick counter's frequency.
25<p>
26The maximum tick count value is equivalent to the maximum uint32 value.
27<p>
28<hr><h2>Member Function Documentation</h2>
29<a name="d4" doxytag="OsclTickCount::MsecToTicks"></a><p>
30<table width="100%" cellpadding="2" cellspacing="0" border="0">
31  <tr>
32    <td class="md">
33      <table cellpadding="0" cellspacing="0" border="0">
34        <tr>
35          <td class="md" nowrap valign="top"> uint32 OsclTickCount::MsecToTicks </td>
36          <td class="md" valign="top">(&nbsp;</td>
37          <td class="md" nowrap valign="top">uint32&nbsp;</td>
38          <td class="mdname1" valign="top" nowrap>&nbsp; <em>msec</em>          </td>
39          <td class="md" valign="top">)&nbsp;</td>
40          <td class="md" nowrap><code> [static]</code></td>
41        </tr>
42
43      </table>
44    </td>
45  </tr>
46</table>
47<table cellspacing=5 cellpadding=0 border=0>
48  <tr>
49    <td>
50      &nbsp;
51    </td>
52    <td>
53
54<p>
55This function converts milliseconds to ticks
56<p>
57<dl compact><dt><b>Returns: </b></dt><dd>
58ticks </dl>    </td>
59  </tr>
60</table>
61<a name="d0" doxytag="OsclTickCount::TickCount"></a><p>
62<table width="100%" cellpadding="2" cellspacing="0" border="0">
63  <tr>
64    <td class="md">
65      <table cellpadding="0" cellspacing="0" border="0">
66        <tr>
67          <td class="md" nowrap valign="top"> uint32 OsclTickCount::TickCount </td>
68          <td class="md" valign="top">(&nbsp;</td>
69          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
70          <td class="md" valign="top">)&nbsp;</td>
71          <td class="md" nowrap><code> [static]</code></td>
72        </tr>
73
74      </table>
75    </td>
76  </tr>
77</table>
78<table cellspacing=5 cellpadding=0 border=0>
79  <tr>
80    <td>
81      &nbsp;
82    </td>
83    <td>
84
85<p>
86This function returns the current system tick count
87<p>
88<dl compact><dt><b>Returns: </b></dt><dd>
89returns the tick count </dl>    </td>
90  </tr>
91</table>
92<a name="d1" doxytag="OsclTickCount::TickCountFrequency"></a><p>
93<table width="100%" cellpadding="2" cellspacing="0" border="0">
94  <tr>
95    <td class="md">
96      <table cellpadding="0" cellspacing="0" border="0">
97        <tr>
98          <td class="md" nowrap valign="top"> uint32 OsclTickCount::TickCountFrequency </td>
99          <td class="md" valign="top">(&nbsp;</td>
100          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
101          <td class="md" valign="top">)&nbsp;</td>
102          <td class="md" nowrap><code> [static]</code></td>
103        </tr>
104
105      </table>
106    </td>
107  </tr>
108</table>
109<table cellspacing=5 cellpadding=0 border=0>
110  <tr>
111    <td>
112      &nbsp;
113    </td>
114    <td>
115
116<p>
117This function returns the tick frequency in ticks per second
118<p>
119<dl compact><dt><b>Returns: </b></dt><dd>
120ticks per second </dl>    </td>
121  </tr>
122</table>
123<a name="d2" doxytag="OsclTickCount::TickCountPeriod"></a><p>
124<table width="100%" cellpadding="2" cellspacing="0" border="0">
125  <tr>
126    <td class="md">
127      <table cellpadding="0" cellspacing="0" border="0">
128        <tr>
129          <td class="md" nowrap valign="top"> uint32 OsclTickCount::TickCountPeriod </td>
130          <td class="md" valign="top">(&nbsp;</td>
131          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
132          <td class="md" valign="top">)&nbsp;</td>
133          <td class="md" nowrap><code> [static]</code></td>
134        </tr>
135
136      </table>
137    </td>
138  </tr>
139</table>
140<table cellspacing=5 cellpadding=0 border=0>
141  <tr>
142    <td>
143      &nbsp;
144    </td>
145    <td>
146
147<p>
148This function returns the tick period in microseconds per tick
149<p>
150<dl compact><dt><b>Returns: </b></dt><dd>
151microseconds per tick </dl>    </td>
152  </tr>
153</table>
154<a name="d3" doxytag="OsclTickCount::TicksToMsec"></a><p>
155<table width="100%" cellpadding="2" cellspacing="0" border="0">
156  <tr>
157    <td class="md">
158      <table cellpadding="0" cellspacing="0" border="0">
159        <tr>
160          <td class="md" nowrap valign="top"> uint32 OsclTickCount::TicksToMsec </td>
161          <td class="md" valign="top">(&nbsp;</td>
162          <td class="md" nowrap valign="top">uint32&nbsp;</td>
163          <td class="mdname1" valign="top" nowrap>&nbsp; <em>ticks</em>          </td>
164          <td class="md" valign="top">)&nbsp;</td>
165          <td class="md" nowrap><code> [static]</code></td>
166        </tr>
167
168      </table>
169    </td>
170  </tr>
171</table>
172<table cellspacing=5 cellpadding=0 border=0>
173  <tr>
174    <td>
175      &nbsp;
176    </td>
177    <td>
178
179<p>
180This function converts ticks to milliseconds
181<p>
182<dl compact><dt><b>Returns: </b></dt><dd>
183milliseconds </dl>    </td>
184  </tr>
185</table>
186<hr>The documentation for this class was generated from the following file:<ul>
187<li><a class="el" href="oscl__tickcount_8h-source.html">oscl_tickcount.h</a></ul>
188<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
189<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
190</small></address>
191</body>
192</html>
193