root / branches / encoders / docs / libdragonfly / group__rangefinder.html @ 856
History | View | Annotate | Download (6.69 KB)
1 | 41 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | 855 | justin | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 | 41 | bcoltin | <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 | 855 | justin | <!-- Generated by Doxygen 1.5.4 -->
|
8 | 41 | bcoltin | <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><a href="files.html"><span>Files</span></a></li> |
||
13 | 855 | justin | <li><a href="pages.html"><span>Related Pages</span></a></li> |
14 | </ul>
|
||
15 | </div>
|
||
16 | 41 | bcoltin | <h1>Rangefinder</h1>Functions for using the IR rangefinders. |
17 | <a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
||
18 | <tr><td></td></tr> |
||
19 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
20 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b2b32709f9770a283701ffcf3723497"></a><!-- doxytag: member="rangefinder::IR1" ref="g7b2b32709f9770a283701ffcf3723497" args="" --> |
||
21 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g7b2b32709f9770a283701ffcf3723497">IR1</a> 6</td></tr> |
||
22 | |||
23 | <tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 1. <br></td></tr> |
||
24 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a08e4f5cb3582e623cc14a6c92d48de"></a><!-- doxytag: member="rangefinder::IR2" ref="g5a08e4f5cb3582e623cc14a6c92d48de" args="" --> |
||
25 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g5a08e4f5cb3582e623cc14a6c92d48de">IR2</a> 5</td></tr> |
||
26 | |||
27 | <tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 2. <br></td></tr> |
||
28 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g26c72d21cca0ec21af4bd9b20ba3ad51"></a><!-- doxytag: member="rangefinder::IR3" ref="g26c72d21cca0ec21af4bd9b20ba3ad51" args="" --> |
||
29 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g26c72d21cca0ec21af4bd9b20ba3ad51">IR3</a> 4</td></tr> |
||
30 | |||
31 | <tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 3. <br></td></tr> |
||
32 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g20f2f5908baa0eeba04b9ceaf718cea0"></a><!-- doxytag: member="rangefinder::IR4" ref="g20f2f5908baa0eeba04b9ceaf718cea0" args="" --> |
||
33 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g20f2f5908baa0eeba04b9ceaf718cea0">IR4</a> 3</td></tr> |
||
34 | |||
35 | <tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 4. <br></td></tr> |
||
36 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g23554754d5334bdc35df623e1e012ede"></a><!-- doxytag: member="rangefinder::IR5" ref="g23554754d5334bdc35df623e1e012ede" args="" --> |
||
37 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g23554754d5334bdc35df623e1e012ede">IR5</a> 2</td></tr> |
||
38 | |||
39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 5. <br></td></tr> |
||
40 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
41 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59">range_init</a> (void)</td></tr> |
||
42 | |||
43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the rangefinders. <a href="#g52d0666b725e6d3a14b5bddc28190e59"></a><br></td></tr> |
||
44 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g22bd0717784e34cb3a0762d78554dcf2">range_read_distance</a> (int range_id)</td></tr> |
||
45 | |||
46 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Read the distance from a rangefinder. <a href="#g22bd0717784e34cb3a0762d78554dcf2"></a><br></td></tr> |
||
47 | </table>
|
||
48 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
49 | Functions for using the IR rangefinders. |
||
50 | <p>
|
||
51 | Functions for using the IR rangefinders. <hr><h2>Function Documentation</h2> |
||
52 | 855 | justin | <a class="anchor" name="g52d0666b725e6d3a14b5bddc28190e59"></a><!-- doxytag: member="rangefinder.c::range_init" ref="g52d0666b725e6d3a14b5bddc28190e59" args="(void)" --> |
53 | <div class="memitem"> |
||
54 | <div class="memproto"> |
||
55 | <table class="memname"> |
||
56 | 41 | bcoltin | <tr>
|
57 | 855 | justin | <td class="memname">void range_init </td> |
58 | <td>(</td> |
||
59 | <td class="paramtype">void </td> |
||
60 | <td class="paramname"> </td> |
||
61 | <td> ) </td> |
||
62 | <td width="100%"></td> |
||
63 | 41 | bcoltin | </tr>
|
64 | </table>
|
||
65 | 855 | justin | </div>
|
66 | <div class="memdoc"> |
||
67 | 41 | bcoltin | |
68 | <p>
|
||
69 | Initialize the rangefinders. |
||
70 | <p>
|
||
71 | Initializes the rangefinders. This must be called before range_read_distance.<p>
|
||
72 | 855 | justin | <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> |
73 | |||
74 | </div>
|
||
75 | </div><p> |
||
76 | <a class="anchor" name="g22bd0717784e34cb3a0762d78554dcf2"></a><!-- doxytag: member="rangefinder.c::range_read_distance" ref="g22bd0717784e34cb3a0762d78554dcf2" args="(int range_id)" --> |
||
77 | <div class="memitem"> |
||
78 | <div class="memproto"> |
||
79 | <table class="memname"> |
||
80 | 41 | bcoltin | <tr>
|
81 | 855 | justin | <td class="memname">int range_read_distance </td> |
82 | <td>(</td> |
||
83 | <td class="paramtype">int </td> |
||
84 | <td class="paramname"> <em>range_id</em> </td> |
||
85 | <td> ) </td> |
||
86 | <td width="100%"></td> |
||
87 | 41 | bcoltin | </tr>
|
88 | </table>
|
||
89 | 855 | justin | </div>
|
90 | <div class="memdoc"> |
||
91 | 41 | bcoltin | |
92 | <p>
|
||
93 | Read the distance from a rangefinder. |
||
94 | <p>
|
||
95 | Reads the distance measured by one of the rangefinders. This distance is in arbitrary units.<p>
|
||
96 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
97 | <table border="0" cellspacing="2" cellpadding="0"> |
||
98 | <tr><td valign="top"></td><td valign="top"><em>range_id</em> </td><td>the rangefinder to use. This should be one of the constants IR1 - IR5.</td></tr> |
||
99 | </table>
|
||
100 | </dl>
|
||
101 | 855 | justin | <dl class="return" compact><dt><b>Returns:</b></dt><dd>the distance measured by the rangefinder</dd></dl> |
102 | <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> |
||
103 | |||
104 | </div>
|
||
105 | </div><p> |
||
106 | 856 | justin | <hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 22 22:30:16 2008 for libdragonfly by |
107 | 41 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
108 | 855 | justin | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address> |
109 | 41 | bcoltin | </body>
|
110 | </html> |