Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / time_8h.html

History | View | Annotate | Download (7.9 KB)

1 41 bcoltin 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 241 bcoltin 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 41 bcoltin 
<title>libdragonfly: time.h File Reference</title>
4 1398 cmar 
<link href="tabs.css" rel="stylesheet" type="text/css">
5 41 bcoltin 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 1398 cmar 
<!-- Generated by Doxygen 1.5.9 -->
8 1145 deffi 
<div class="navigation" id="top">
9 
  <div class="tabs">
10 
    <ul>
11 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13 
      <li><a href="modules.html"><span>Modules</span></a></li>
14 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
16 
    </ul>
17 
  </div>
18 1398 cmar 
  <div class="tabs">
19 
    <ul>
20 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21 
      <li><a href="globals.html"><span>Globals</span></a></li>
22 
    </ul>
23 
  </div>
24 241 bcoltin 
</div>
25 1145 deffi 
<div class="contents">
26 1398 cmar 
<h1>time.h File Reference</h1>Contains time-related functions and definitions.
27 
<a href="#_details">More...</a>
28 41 bcoltin 
<p>
29 

      

      

        30
        
        
        
        
        
<p>


      

      

        31
        
            1398
        
        
            cmar
        
        
<a href="time_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">


      

      

        32
        
            41
        
        
            bcoltin
        
        
<tr><td></td></tr>


      

      

        33
        
        
        
        
        
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>


      

      

        34
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd271145628da4e0e85e3e2486d117713"></a><!-- doxytag: member="time.h::SIXTEENTH_SECOND" ref="gd271145628da4e0e85e3e2486d117713" args="" -->


      

      

        35
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gd271145628da4e0e85e3e2486d117713">SIXTEENTH_SECOND</a>&nbsp;&nbsp;&nbsp;1</td></tr>


      

      

        36
        
        
        
        
        

      

      

        37
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A sixteenth of a second. <br></td></tr>


      

      

        38
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7bdae984203001070e9abeb3190f844a"></a><!-- doxytag: member="time.h::EIGTH_SECOND" ref="g7bdae984203001070e9abeb3190f844a" args="" -->


      

      

        39
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g7bdae984203001070e9abeb3190f844a">EIGTH_SECOND</a>&nbsp;&nbsp;&nbsp;2</td></tr>


      

      

        40
        
        
        
        
        

      

      

        41
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An eighth of a second. <br></td></tr>


      

      

        42
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b2a348d9afca1f1182bc2bb2aa6a3d1"></a><!-- doxytag: member="time.h::QUARTER_SECOND" ref="g0b2a348d9afca1f1182bc2bb2aa6a3d1" args="" -->


      

      

        43
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g0b2a348d9afca1f1182bc2bb2aa6a3d1">QUARTER_SECOND</a>&nbsp;&nbsp;&nbsp;4</td></tr>


      

      

        44
        
        
        
        
        

      

      

        45
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A quarter of a second. <br></td></tr>


      

      

        46
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf95f27544f39827250d6bef6fa5fe18e"></a><!-- doxytag: member="time.h::HALF_SECOND" ref="gf95f27544f39827250d6bef6fa5fe18e" args="" -->


      

      

        47
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gf95f27544f39827250d6bef6fa5fe18e">HALF_SECOND</a>&nbsp;&nbsp;&nbsp;8</td></tr>


      

      

        48
        
        
        
        
        

      

      

        49
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Half of a second. <br></td></tr>


      

      

        50
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g94212be2394d2d37d9dfd33d07d82dba"></a><!-- doxytag: member="time.h::SECOND" ref="g94212be2394d2d37d9dfd33d07d82dba" args="" -->


      

      

        51
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g94212be2394d2d37d9dfd33d07d82dba">SECOND</a>&nbsp;&nbsp;&nbsp;16</td></tr>


      

      

        52
        
        
        
        
        

      

      

        53
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">One second. <br></td></tr>


      

      

        54
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c2dc0c899e1571596205f29fcc35cd6"></a><!-- doxytag: member="time.h::TWO_SECOND" ref="g4c2dc0c899e1571596205f29fcc35cd6" args="" -->


      

      

        55
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4c2dc0c899e1571596205f29fcc35cd6">TWO_SECOND</a>&nbsp;&nbsp;&nbsp;32</td></tr>


      

      

        56
        
        
        
        
        

      

      

        57
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Two seconds. <br></td></tr>


      

      

        58
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g335312d1eed285bbc48a7f383ad78d97"></a><!-- doxytag: member="time.h::FOUR_SECOND" ref="g335312d1eed285bbc48a7f383ad78d97" args="" -->


      

      

        59
        
        
        
        
        
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g335312d1eed285bbc48a7f383ad78d97">FOUR_SECOND</a>&nbsp;&nbsp;&nbsp;64</td></tr>


      

      

        60
        
        
        
        
        

      

      

        61
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Four seconds. <br></td></tr>


      

      

        62
        
        
        
        
        
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


      

      

        63
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g8aa473f8ae9a91df4bc9ea700983c72d">delay_ms</a> (int ms)</td></tr>


      

      

        64
        
        
        
        
        

      

      

        65
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delay execution for the specified time.  <a href="group__time.html#g8aa473f8ae9a91df4bc9ea700983c72d"></a><br></td></tr>


      

      

        66
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</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>


      

      

        67
        
        
        
        
        

      

      

        68
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enable the realtime clock.  <a href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553"></a><br></td></tr>


      

      

        69
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> (void)</td></tr>


      

      

        70
        
        
        
        
        

      

      

        71
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the counter of the realtime clock.  <a href="group__time.html#g83ae542199d1c0e964aff89537d686a3"></a><br></td></tr>


      

      

        72
        
        
        
        
        
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a> (void)</td></tr>


      

      

        73
        
        
        
        
        

      

      

        74
        
        
        
        
        
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of the realtime clock.  <a href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d"></a><br></td></tr>


      

      

        75
        
        
        
        
        
</table>


      

      

        76
        
            1398
        
        
            cmar
        
        
<hr><h2>Detailed Description</h2>


      

      

        77
        
            41
        
        
            bcoltin
        
        
Contains time-related functions and definitions.


      

      

        78
        
        
        
        
        
<p>


      

      

        79
        
            241
        
        
            bcoltin
        
        
Copyright (c) 2007 Colony Project<p>


      

      

        80
        
        
        
        
        
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>


      

      

        81
        
        
        
        
        
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>


      

      

        82
        
        
        
        
        
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p>


      

      

        83
        
            41
        
        
            bcoltin
        
        
Contains functions and definitions for dealing with time, namely delay_ms and the realtime clock.<p>


      

      

        84
        
            241
        
        
            bcoltin
        
        
<dl class="author" compact><dt><b>Author:</b></dt><dd>Colony Project, CMU Robotics Club </dd></dl>


      

      

        85
        
            1145
        
        
            deffi
        
        
</div>


      

      

        86
        
            1398
        
        
            cmar
        
        
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by&nbsp;


      

      

        87
        
            41
        
        
            bcoltin
        
        
<a href="http://www.doxygen.org/index.html">


      

      

        88
        
            1398
        
        
            cmar
        
        
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


      

      

        89
        
            41
        
        
            bcoltin
        
        
</body>


      

      

        90
        
        
        
        
        
</html>