root / trunk / docs / libdragonfly / time_8h.html @ 41
History | View | Annotate | Download (6.62 KB)
1 | 41 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
3 | <title>libdragonfly: time.h File Reference</title> |
||
4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
||
5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
||
6 | </head><body> |
||
7 | <!-- Generated by Doxygen 1.4.6 -->
|
||
8 | <div class="tabs"> |
||
9 | <ul>
|
||
10 | <li><a href="index.html"><span>Main Page</span></a></li> |
||
11 | <li><a href="modules.html"><span>Modules</span></a></li> |
||
12 | <li id="current"><a href="files.html"><span>Files</span></a></li> |
||
13 | </ul></div> |
||
14 | <div class="tabs"> |
||
15 | <ul>
|
||
16 | <li><a href="files.html"><span>File List</span></a></li> |
||
17 | <li><a href="globals.html"><span>Globals</span></a></li> |
||
18 | </ul></div> |
||
19 | <h1>time.h File Reference</h1>Contains time-related functions and definitions. <a href="#_details">More...</a> |
||
20 | <p>
|
||
21 | |||
22 | <p>
|
||
23 | <a href="time_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
24 | <tr><td></td></tr> |
||
25 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
26 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd271145628da4e0e85e3e2486d117713"></a><!-- doxytag: member="time.h::SIXTEENTH_SECOND" ref="gd271145628da4e0e85e3e2486d117713" args="" --> |
||
27 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gd271145628da4e0e85e3e2486d117713">SIXTEENTH_SECOND</a> 1</td></tr> |
||
28 | |||
29 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A sixteenth of a second. <br></td></tr> |
||
30 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7bdae984203001070e9abeb3190f844a"></a><!-- doxytag: member="time.h::EIGTH_SECOND" ref="g7bdae984203001070e9abeb3190f844a" args="" --> |
||
31 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g7bdae984203001070e9abeb3190f844a">EIGTH_SECOND</a> 2</td></tr> |
||
32 | |||
33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An eighth of a second. <br></td></tr> |
||
34 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b2a348d9afca1f1182bc2bb2aa6a3d1"></a><!-- doxytag: member="time.h::QUARTER_SECOND" ref="g0b2a348d9afca1f1182bc2bb2aa6a3d1" args="" --> |
||
35 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g0b2a348d9afca1f1182bc2bb2aa6a3d1">QUARTER_SECOND</a> 4</td></tr> |
||
36 | |||
37 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A quarter of a second. <br></td></tr> |
||
38 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf95f27544f39827250d6bef6fa5fe18e"></a><!-- doxytag: member="time.h::HALF_SECOND" ref="gf95f27544f39827250d6bef6fa5fe18e" args="" --> |
||
39 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gf95f27544f39827250d6bef6fa5fe18e">HALF_SECOND</a> 8</td></tr> |
||
40 | |||
41 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Half of a second. <br></td></tr> |
||
42 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g94212be2394d2d37d9dfd33d07d82dba"></a><!-- doxytag: member="time.h::SECOND" ref="g94212be2394d2d37d9dfd33d07d82dba" args="" --> |
||
43 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g94212be2394d2d37d9dfd33d07d82dba">SECOND</a> 16</td></tr> |
||
44 | |||
45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">One second. <br></td></tr> |
||
46 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c2dc0c899e1571596205f29fcc35cd6"></a><!-- doxytag: member="time.h::TWO_SECOND" ref="g4c2dc0c899e1571596205f29fcc35cd6" args="" --> |
||
47 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4c2dc0c899e1571596205f29fcc35cd6">TWO_SECOND</a> 32</td></tr> |
||
48 | |||
49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Two seconds. <br></td></tr> |
||
50 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g335312d1eed285bbc48a7f383ad78d97"></a><!-- doxytag: member="time.h::FOUR_SECOND" ref="g335312d1eed285bbc48a7f383ad78d97" args="" --> |
||
51 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g335312d1eed285bbc48a7f383ad78d97">FOUR_SECOND</a> 64</td></tr> |
||
52 | |||
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Four seconds. <br></td></tr> |
||
54 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
55 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g8aa473f8ae9a91df4bc9ea700983c72d">delay_ms</a> (int ms)</td></tr> |
||
56 | |||
57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Delay execution for the specified time. <a href="group__time.html#g8aa473f8ae9a91df4bc9ea700983c72d"></a><br></td></tr> |
||
58 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553">rtc_init</a> (int prescale_opt, void(*rtc_func)(void))</td></tr> |
||
59 | |||
60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the realtime clock. <a href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553"></a><br></td></tr> |
||
61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> (void)</td></tr> |
||
62 | |||
63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the counter of the realtime clock. <a href="group__time.html#g83ae542199d1c0e964aff89537d686a3"></a><br></td></tr> |
||
64 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a> (void)</td></tr> |
||
65 | |||
66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the realtime clock. <a href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d"></a><br></td></tr> |
||
67 | </table>
|
||
68 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
69 | Contains time-related functions and definitions. |
||
70 | <p>
|
||
71 | Contains functions and definitions for dealing with time, namely delay_ms and the realtime clock.<p>
|
||
72 | <dl compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl> |
||
73 | <hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 15:36:18 2007 for libdragonfly by |
||
74 | <a href="http://www.doxygen.org/index.html"> |
||
75 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
||
76 | </body>
|
||
77 | </html> |