Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / group__rangefinder.html @ 948

History | View | Annotate | Download (6.76 KB)

1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 
<title>libdragonfly: Rangefinder</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.5.3 -->
8 
<div class="tabs">
9 
  <ul>
10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 
    <li><a href="files.html"><span>Files</span></a></li>
14 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15 
  </ul>
16 
</div>
17 
<h1>Rangefinder</h1>Functions for using the IR rangefinders.
18 
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
19 
<tr><td></td></tr>
20 
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
21 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b2b32709f9770a283701ffcf3723497"></a><!-- doxytag: member="rangefinder::IR1" ref="g7b2b32709f9770a283701ffcf3723497" args="" -->
22 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g7b2b32709f9770a283701ffcf3723497">IR1</a>&nbsp;&nbsp;&nbsp;6</td></tr>
23 

    		
  

  

    
      24
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IR Rangefinder 1. <br></td></tr>


    		
  

  

    
      25
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a08e4f5cb3582e623cc14a6c92d48de"></a><!-- doxytag: member="rangefinder::IR2" ref="g5a08e4f5cb3582e623cc14a6c92d48de" args="" -->


    		
  

  

    
      26
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g5a08e4f5cb3582e623cc14a6c92d48de">IR2</a>&nbsp;&nbsp;&nbsp;5</td></tr>


    		
  

  

    
      27
    
    
      

    		
  

  

    
      28
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IR Rangefinder 2. <br></td></tr>


    		
  

  

    
      29
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g26c72d21cca0ec21af4bd9b20ba3ad51"></a><!-- doxytag: member="rangefinder::IR3" ref="g26c72d21cca0ec21af4bd9b20ba3ad51" args="" -->


    		
  

  

    
      30
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g26c72d21cca0ec21af4bd9b20ba3ad51">IR3</a>&nbsp;&nbsp;&nbsp;4</td></tr>


    		
  

  

    
      31
    
    
      

    		
  

  

    
      32
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IR Rangefinder 3. <br></td></tr>


    		
  

  

    
      33
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g20f2f5908baa0eeba04b9ceaf718cea0"></a><!-- doxytag: member="rangefinder::IR4" ref="g20f2f5908baa0eeba04b9ceaf718cea0" args="" -->


    		
  

  

    
      34
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g20f2f5908baa0eeba04b9ceaf718cea0">IR4</a>&nbsp;&nbsp;&nbsp;3</td></tr>


    		
  

  

    
      35
    
    
      

    		
  

  

    
      36
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IR Rangefinder 4. <br></td></tr>


    		
  

  

    
      37
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g23554754d5334bdc35df623e1e012ede"></a><!-- doxytag: member="rangefinder::IR5" ref="g23554754d5334bdc35df623e1e012ede" args="" -->


    		
  

  

    
      38
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g23554754d5334bdc35df623e1e012ede">IR5</a>&nbsp;&nbsp;&nbsp;2</td></tr>


    		
  

  

    
      39
    
    
      

    		
  

  

    
      40
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IR Rangefinder 5. <br></td></tr>


    		
  

  

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


    		
  

  

    
      42
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59">range_init</a> (void)</td></tr>


    		
  

  

    
      43
    
    
      

    		
  

  

    
      44
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the rangefinders.  <a href="#g52d0666b725e6d3a14b5bddc28190e59"></a><br></td></tr>


    		
  

  

    
      45
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g22bd0717784e34cb3a0762d78554dcf2">range_read_distance</a> (int range_id)</td></tr>


    		
  

  

    
      46
    
    
      

    		
  

  

    
      47
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the distance from a rangefinder.  <a href="#g22bd0717784e34cb3a0762d78554dcf2"></a><br></td></tr>


    		
  

  

    
      48
    
    
      
</table>


    		
  

  

    
      49
    
    
      
<hr><a name="_details"></a><h2>Detailed Description</h2>


    		
  

  

    
      50
    
    
      
Functions for using the IR rangefinders. 


    		
  

  

    
      51
    
    
      
<p>


    		
  

  

    
      52
    
    
      
Functions for using the IR rangefinders. <hr><h2>Function Documentation</h2>


    		
  

  

    
      53
    
    
      
<a class="anchor" name="g52d0666b725e6d3a14b5bddc28190e59"></a><!-- doxytag: member="rangefinder.c::range_init" ref="g52d0666b725e6d3a14b5bddc28190e59" args="(void)" -->


    		
  

  

    
      54
    
    
      
<div class="memitem">


    		
  

  

    
      55
    
    
      
<div class="memproto">


    		
  

  

    
      56
    
    
      
      <table class="memname">


    		
  

  

    
      57
    
    
      
        <tr>


    		
  

  

    
      58
    
    
      
          <td class="memname">void range_init           </td>


    		
  

  

    
      59
    
    
      
          <td>(</td>


    		
  

  

    
      60
    
    
      
          <td class="paramtype">void&nbsp;</td>


    		
  

  

    
      61
    
    
      
          <td class="paramname">          </td>


    		
  

  

    
      62
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      63
    
    
      
          <td width="100%"></td>


    		
  

  

    
      64
    
    
      
        </tr>


    		
  

  

    
      65
    
    
      
      </table>


    		
  

  

    
      66
    
    
      
</div>


    		
  

  

    
      67
    
    
      
<div class="memdoc">


    		
  

  

    
      68
    
    
      

    		
  

  

    
      69
    
    
      
<p>


    		
  

  

    
      70
    
    
      
Initialize the rangefinders. 


    		
  

  

    
      71
    
    
      
<p>


    		
  

  

    
      72
    
    
      
Initializes the rangefinders. This must be called before range_read_distance.<p>


    		
  

  

    
      73
    
    
      
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__rangefinder.html#g22bd0717784e34cb3a0762d78554dcf2" title="Read the distance from a rangefinder.">range_read_distance</a> </dd></dl>


    		
  

  

    
      74
    
    
      

    		
  

  

    
      75
    
    
      
</div>


    		
  

  

    
      76
    
    
      
</div><p>


    		
  

  

    
      77
    
    
      
<a class="anchor" name="g22bd0717784e34cb3a0762d78554dcf2"></a><!-- doxytag: member="rangefinder.c::range_read_distance" ref="g22bd0717784e34cb3a0762d78554dcf2" args="(int range_id)" -->


    		
  

  

    
      78
    
    
      
<div class="memitem">


    		
  

  

    
      79
    
    
      
<div class="memproto">


    		
  

  

    
      80
    
    
      
      <table class="memname">


    		
  

  

    
      81
    
    
      
        <tr>


    		
  

  

    
      82
    
    
      
          <td class="memname">int range_read_distance           </td>


    		
  

  

    
      83
    
    
      
          <td>(</td>


    		
  

  

    
      84
    
    
      
          <td class="paramtype">int&nbsp;</td>


    		
  

  

    
      85
    
    
      
          <td class="paramname"> <em>range_id</em>          </td>


    		
  

  

    
      86
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      87
    
    
      
          <td width="100%"></td>


    		
  

  

    
      88
    
    
      
        </tr>


    		
  

  

    
      89
    
    
      
      </table>


    		
  

  

    
      90
    
    
      
</div>


    		
  

  

    
      91
    
    
      
<div class="memdoc">


    		
  

  

    
      92
    
    
      

    		
  

  

    
      93
    
    
      
<p>


    		
  

  

    
      94
    
    
      
Read the distance from a rangefinder. 


    		
  

  

    
      95
    
    
      
<p>


    		
  

  

    
      96
    
    
      
Reads the distance measured by one of the rangefinders. This distance is in arbitrary units.<p>


    		
  

  

    
      97
    
    
      
<dl compact><dt><b>Parameters:</b></dt><dd>


    		
  

  

    
      98
    
    
      
  <table border="0" cellspacing="2" cellpadding="0">


    		
  

  

    
      99
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>range_id</em>&nbsp;</td><td>the rangefinder to use. This should be one of the constants IR1 - IR5.</td></tr>


    		
  

  

    
      100
    
    
      
  </table>


    		
  

  

    
      101
    
    
      
</dl>


    		
  

  

    
      102
    
    
      
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the distance measured by the rangefinder</dd></dl>


    		
  

  

    
      103
    
    
      
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59" title="Initialize the rangefinders.">range_init</a> </dd></dl>


    		
  

  

    
      104
    
    
      

    		
  

  

    
      105
    
    
      
</div>


    		
  

  

    
      106
    
    
      
</div><p>


    		
  

  

    
      107
    
    
      
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:43 2008 for libdragonfly by&nbsp;


    		
  

  

    
      108
    
    
      
<a href="http://www.doxygen.org/index.html">


    		
  

  

    
      109
    
    
      
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>


    		
  

  

    
      110
    
    
      
</body>


    		
  

  

    
      111
    
    
      
</html>