root / trunk / docs / libwireless / group__sensormatrix.html @ 1427
History | View | Annotate | Download (14.9 KB)
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
---|---|
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
3 |
<head>
|
4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
5 |
<title>libwireless: Sensor Matrix</title> |
6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
8 |
</head>
|
9 |
<body>
|
10 |
<!-- Generated by Doxygen 1.6.1 -->
|
11 |
<div class="navigation" id="top"> |
12 |
<div class="tabs"> |
13 |
<ul>
|
14 |
<li><a href="index.html"><span>Main Page</span></a></li> |
15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
16 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
17 |
<li><a href="files.html"><span>Files</span></a></li> |
18 |
</ul>
|
19 |
</div>
|
20 |
</div>
|
21 |
<div class="contents"> |
22 |
<h1>Sensor Matrix</h1> |
23 |
<p>the robot sensor matrix
|
24 |
<a href="#_details">More...</a></p> |
25 |
<table border="0" cellpadding="0" cellspacing="0"> |
26 |
<tr><td colspan="2"><h2>Data Structures</h2></td></tr> |
27 |
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html">SensorMatrix</a></td></tr> |
28 |
<tr><td colspan="2"><h2>Defines</h2></td></tr> |
29 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga90947d420e328af375fda40c9b199b7d"></a><!-- doxytag: member="sensormatrix::MAXIMUM_XBEE_ID" ref="ga90947d420e328af375fda40c9b199b7d" args="" --> |
30 |
#define </td><td class="memItemRight" valign="bottom"><b>MAXIMUM_XBEE_ID</b> 0x10</td></tr> |
31 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga782ef5f54e97435c631329a5e536f680"></a><!-- doxytag: member="sensormatrix::READING_UNKNOWN" ref="ga782ef5f54e97435c631329a5e536f680" args="" --> |
32 |
#define </td><td class="memItemRight" valign="bottom"><b>READING_UNKNOWN</b> 0xFF</td></tr> |
33 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
34 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga09523e52546e7929288795e1e5f0f9a8">sensor_matrix_create</a> (void)</td></tr> |
35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a sensor matrix. <a href="#ga09523e52546e7929288795e1e5f0f9a8"></a><br/></td></tr> |
36 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaf251d97aeb23af9156c0527692819da7">sensor_matrix_set_reading</a> (int observer, int robot, int reading)</td></tr> |
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a reading in a sensor matrix. <a href="#gaf251d97aeb23af9156c0527692819da7"></a><br/></td></tr> |
38 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga031d5a4d15603e57379aad22da36e300">sensor_matrix_get_reading</a> (int observer, int robot)</td></tr> |
39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a reading in a sensor matrix. <a href="#ga031d5a4d15603e57379aad22da36e300"></a><br/></td></tr> |
40 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaea879c1d5f8a8a079066d8df005f3549">sensor_matrix_set_in_ring</a> (int robot, int in)</td></tr> |
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether the robot is in the token ring. <a href="#gaea879c1d5f8a8a079066d8df005f3549"></a><br/></td></tr> |
42 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gac668dfe28e56b5a314789d395eda3b27">sensor_matrix_get_in_ring</a> (int robot)</td></tr> |
43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get whether the robot is in the sensor ring. <a href="#gac668dfe28e56b5a314789d395eda3b27"></a><br/></td></tr> |
44 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga3545800eec0adba2fc63604206b8fb24">sensor_matrix_get_joined</a> (void)</td></tr> |
45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of robots which have joined the token ring. <a href="#ga3545800eec0adba2fc63604206b8fb24"></a><br/></td></tr> |
46 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaa22a0851d1886ca29fc32e0692502f2d">sensor_matrix_get_size</a> (void)</td></tr> |
47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum size of the sensor matrix. <a href="#gaa22a0851d1886ca29fc32e0692502f2d"></a><br/></td></tr> |
48 |
</table>
|
49 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
50 |
<p>the robot sensor matrix </p> |
51 |
<p>These functions and structures are used for localization to determine the relative directions of robots. </p> |
52 |
<hr/><h2>Function Documentation</h2> |
53 |
<a class="anchor" id="ga09523e52546e7929288795e1e5f0f9a8"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_create" ref="ga09523e52546e7929288795e1e5f0f9a8" args="(void)" --> |
54 |
<div class="memitem"> |
55 |
<div class="memproto"> |
56 |
<table class="memname"> |
57 |
<tr>
|
58 |
<td class="memname">void sensor_matrix_create </td> |
59 |
<td>(</td> |
60 |
<td class="paramtype">void </td> |
61 |
<td class="paramname"></td> |
62 |
<td> ) </td> |
63 |
<td></td> |
64 |
</tr>
|
65 |
</table>
|
66 |
</div>
|
67 |
<div class="memdoc"> |
68 |
|
69 |
<p>Create a sensor matrix. </p> |
70 |
<p>Initializes the sensor matrix.</p> |
71 |
<dl class="return"><dt><b>Returns:</b></dt><dd>the newly created sensor matrix </dd></dl> |
72 |
|
73 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00070">SensorMatrix::joined</a>, <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>, and <a class="el" href="sensor__matrix_8h_source.html#l00065">SensorMatrix::numJoined</a>.</p> |
74 |
|
75 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p> |
76 |
|
77 |
</div>
|
78 |
</div>
|
79 |
<a class="anchor" id="gac668dfe28e56b5a314789d395eda3b27"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_in_ring" ref="gac668dfe28e56b5a314789d395eda3b27" args="(int robot)" --> |
80 |
<div class="memitem"> |
81 |
<div class="memproto"> |
82 |
<table class="memname"> |
83 |
<tr>
|
84 |
<td class="memname">int sensor_matrix_get_in_ring </td> |
85 |
<td>(</td> |
86 |
<td class="paramtype">int </td> |
87 |
<td class="paramname"> <em>robot</em></td> |
88 |
<td> ) </td> |
89 |
<td></td> |
90 |
</tr>
|
91 |
</table>
|
92 |
</div>
|
93 |
<div class="memdoc"> |
94 |
|
95 |
<p>Get whether the robot is in the sensor ring. </p> |
96 |
<p>Checks if the given robot is in the token ring.</p> |
97 |
<dl><dt><b>Parameters:</b></dt><dd> |
98 |
<table border="0" cellspacing="2" cellpadding="0"> |
99 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the ID of the robot to check</td></tr> |
100 |
</table>
|
101 |
</dd>
|
102 |
</dl>
|
103 |
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the robot is in the token ring, 0 otherwise </dd></dl> |
104 |
|
105 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00070">SensorMatrix::joined</a>.</p> |
106 |
|
107 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00394">wl_token_is_robot_in_ring()</a>, <a class="el" href="wl__token__ring_8c_source.html#l00404">wl_token_iterator_begin()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00446">wl_token_iterator_next()</a>.</p> |
108 |
|
109 |
</div>
|
110 |
</div>
|
111 |
<a class="anchor" id="ga3545800eec0adba2fc63604206b8fb24"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_joined" ref="ga3545800eec0adba2fc63604206b8fb24" args="(void)" --> |
112 |
<div class="memitem"> |
113 |
<div class="memproto"> |
114 |
<table class="memname"> |
115 |
<tr>
|
116 |
<td class="memname">int sensor_matrix_get_joined </td> |
117 |
<td>(</td> |
118 |
<td class="paramtype">void </td> |
119 |
<td class="paramname"></td> |
120 |
<td> ) </td> |
121 |
<td></td> |
122 |
</tr>
|
123 |
</table>
|
124 |
</div>
|
125 |
<div class="memdoc"> |
126 |
|
127 |
<p>Get the number of robots which have joined the token ring. </p> |
128 |
<p>Returns the number of robots which have joined the token ring.</p> |
129 |
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl> |
130 |
|
131 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00065">SensorMatrix::numJoined</a>.</p> |
132 |
|
133 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00478">wl_token_get_num_robots()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00380">wl_token_get_robots_in_ring()</a>.</p> |
134 |
|
135 |
</div>
|
136 |
</div>
|
137 |
<a class="anchor" id="ga031d5a4d15603e57379aad22da36e300"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_reading" ref="ga031d5a4d15603e57379aad22da36e300" args="(int observer, int robot)" --> |
138 |
<div class="memitem"> |
139 |
<div class="memproto"> |
140 |
<table class="memname"> |
141 |
<tr>
|
142 |
<td class="memname">int sensor_matrix_get_reading </td> |
143 |
<td>(</td> |
144 |
<td class="paramtype">int </td> |
145 |
<td class="paramname"> <em>observer</em>, </td> |
146 |
</tr>
|
147 |
<tr>
|
148 |
<td class="paramkey"></td> |
149 |
<td></td> |
150 |
<td class="paramtype">int </td> |
151 |
<td class="paramname"> <em>robot</em></td><td> </td> |
152 |
</tr>
|
153 |
<tr>
|
154 |
<td></td> |
155 |
<td>)</td> |
156 |
<td></td><td></td><td></td> |
157 |
</tr>
|
158 |
</table>
|
159 |
</div>
|
160 |
<div class="memdoc"> |
161 |
|
162 |
<p>Get a reading in a sensor matrix. </p> |
163 |
<p>Gets the sensor reading for a robot to another robot.</p> |
164 |
<dl><dt><b>Parameters:</b></dt><dd> |
165 |
<table border="0" cellspacing="2" cellpadding="0"> |
166 |
<tr><td valign="top"></td><td valign="top"><em>observer</em> </td><td>the robot whose reading we check </td></tr> |
167 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the robot who we are checking the reading to</td></tr> |
168 |
</table>
|
169 |
</dd>
|
170 |
</dl>
|
171 |
<dl class="return"><dt><b>Returns:</b></dt><dd>the observer's BOM reading for robot </dd></dl> |
172 |
|
173 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>.</p> |
174 |
|
175 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00347">wl_token_get_sensor_reading()</a>.</p> |
176 |
|
177 |
</div>
|
178 |
</div>
|
179 |
<a class="anchor" id="gaa22a0851d1886ca29fc32e0692502f2d"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_size" ref="gaa22a0851d1886ca29fc32e0692502f2d" args="(void)" --> |
180 |
<div class="memitem"> |
181 |
<div class="memproto"> |
182 |
<table class="memname"> |
183 |
<tr>
|
184 |
<td class="memname">int sensor_matrix_get_size </td> |
185 |
<td>(</td> |
186 |
<td class="paramtype">void </td> |
187 |
<td class="paramname"></td> |
188 |
<td> ) </td> |
189 |
<td></td> |
190 |
</tr>
|
191 |
</table>
|
192 |
</div>
|
193 |
<div class="memdoc"> |
194 |
|
195 |
<p>Get the maximum size of the sensor matrix. </p> |
196 |
<p>Returns the maximum XBee id of a robot which can be stored in the sensor matrix.</p> |
197 |
<dl class="return"><dt><b>Returns:</b></dt><dd>the maximum number of robots which can be stored </dd></dl> |
198 |
|
199 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00490">wl_token_get_matrix_size()</a>, <a class="el" href="wl__token__ring_8c_source.html#l00404">wl_token_iterator_begin()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00446">wl_token_iterator_next()</a>.</p> |
200 |
|
201 |
</div>
|
202 |
</div>
|
203 |
<a class="anchor" id="gaea879c1d5f8a8a079066d8df005f3549"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_in_ring" ref="gaea879c1d5f8a8a079066d8df005f3549" args="(int robot, int in)" --> |
204 |
<div class="memitem"> |
205 |
<div class="memproto"> |
206 |
<table class="memname"> |
207 |
<tr>
|
208 |
<td class="memname">void sensor_matrix_set_in_ring </td> |
209 |
<td>(</td> |
210 |
<td class="paramtype">int </td> |
211 |
<td class="paramname"> <em>robot</em>, </td> |
212 |
</tr>
|
213 |
<tr>
|
214 |
<td class="paramkey"></td> |
215 |
<td></td> |
216 |
<td class="paramtype">int </td> |
217 |
<td class="paramname"> <em>in</em></td><td> </td> |
218 |
</tr>
|
219 |
<tr>
|
220 |
<td></td> |
221 |
<td>)</td> |
222 |
<td></td><td></td><td></td> |
223 |
</tr>
|
224 |
</table>
|
225 |
</div>
|
226 |
<div class="memdoc"> |
227 |
|
228 |
<p>Set whether the robot is in the token ring. </p> |
229 |
<p>Sets whether or not the given robot is part of the token ring.</p> |
230 |
<dl><dt><b>Parameters:</b></dt><dd> |
231 |
<table border="0" cellspacing="2" cellpadding="0"> |
232 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the robot to set as a member / nonmember of the token ring </td></tr> |
233 |
<tr><td valign="top"></td><td valign="top"><em>in</em> </td><td>1 if the robot is in the token ring, 0 otherwise </td></tr> |
234 |
</table>
|
235 |
</dd>
|
236 |
</dl>
|
237 |
|
238 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00070">SensorMatrix::joined</a>, and <a class="el" href="sensor__matrix_8h_source.html#l00065">SensorMatrix::numJoined</a>.</p> |
239 |
|
240 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p> |
241 |
|
242 |
</div>
|
243 |
</div>
|
244 |
<a class="anchor" id="gaf251d97aeb23af9156c0527692819da7"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_reading" ref="gaf251d97aeb23af9156c0527692819da7" args="(int observer, int robot, int reading)" --> |
245 |
<div class="memitem"> |
246 |
<div class="memproto"> |
247 |
<table class="memname"> |
248 |
<tr>
|
249 |
<td class="memname">void sensor_matrix_set_reading </td> |
250 |
<td>(</td> |
251 |
<td class="paramtype">int </td> |
252 |
<td class="paramname"> <em>observer</em>, </td> |
253 |
</tr>
|
254 |
<tr>
|
255 |
<td class="paramkey"></td> |
256 |
<td></td> |
257 |
<td class="paramtype">int </td> |
258 |
<td class="paramname"> <em>robot</em>, </td> |
259 |
</tr>
|
260 |
<tr>
|
261 |
<td class="paramkey"></td> |
262 |
<td></td> |
263 |
<td class="paramtype">int </td> |
264 |
<td class="paramname"> <em>reading</em></td><td> </td> |
265 |
</tr>
|
266 |
<tr>
|
267 |
<td></td> |
268 |
<td>)</td> |
269 |
<td></td><td></td><td></td> |
270 |
</tr>
|
271 |
</table>
|
272 |
</div>
|
273 |
<div class="memdoc"> |
274 |
|
275 |
<p>Set a reading in a sensor matrix. </p> |
276 |
<p>Sets the sensor reading for robot robot to reading.</p> |
277 |
<dl><dt><b>Parameters:</b></dt><dd> |
278 |
<table border="0" cellspacing="2" cellpadding="0"> |
279 |
<tr><td valign="top"></td><td valign="top"><em>observer</em> </td><td>the id of the robot who made the reading </td></tr> |
280 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the id of the robot who the reading is for </td></tr> |
281 |
<tr><td valign="top"></td><td valign="top"><em>reading</em> </td><td>the BOM reading from observer to robot </td></tr> |
282 |
</table>
|
283 |
</dd>
|
284 |
</dl>
|
285 |
|
286 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>.</p> |
287 |
|
288 |
</div>
|
289 |
</div>
|
290 |
</div>
|
291 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by |
292 |
<a href="http://www.doxygen.org/index.html"> |
293 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
294 |
</body>
|
295 |
</html>
|