root / trunk / docs / libwireless / group__sensormatrix.html @ 60
History | View | Annotate | Download (22.9 KB)
1 |
<!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>libwireless: Sensor Matrix</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><a href="annotated.html"><span>Data Structures</span></a></li> |
13 |
<li><a href="files.html"><span>Files</span></a></li> |
14 |
</ul></div> |
15 |
<h1>Sensor Matrix</h1>the robot sensor matrix |
16 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
17 |
<tr><td></td></tr> |
18 |
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
19 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html">SensorMatrix</a></td></tr> |
20 |
|
21 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html">SensorMatrix</a></td></tr> |
22 |
|
23 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gdac971de8e0df3ed469c1e00b5d68ec3">sensor_matrix_create</a> (void)</td></tr> |
25 |
|
26 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a sensor matrix. <a href="#gdac971de8e0df3ed469c1e00b5d68ec3"></a><br></td></tr> |
27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g6125c1926243c789c9a22c7b7ca915f7">sensor_matrix_destroy</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m)</td></tr> |
28 |
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a sensor matrix. <a href="#g6125c1926243c789c9a22c7b7ca915f7"></a><br></td></tr> |
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g4a8cea8d7401802b8ef4f24768671cdb">sensor_matrix_add_robot</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m, unsigned int id)</td></tr> |
31 |
|
32 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a robot to a sensor matrix. <a href="#g4a8cea8d7401802b8ef4f24768671cdb"></a><br></td></tr> |
33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g616455f4c0801504984cc7f7cf49d980">sensor_matrix_remove_robot</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m, unsigned int id)</td></tr> |
34 |
|
35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a robot from a sensor matrix. <a href="#g616455f4c0801504984cc7f7cf49d980"></a><br></td></tr> |
36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g06977570b0c7b9628caeb5de012bbf22">sensor_matrix_set_reading</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m, int observer, int robot, int reading)</td></tr> |
37 |
|
38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a reading in a sensor matrix. <a href="#g06977570b0c7b9628caeb5de012bbf22"></a><br></td></tr> |
39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gf8f7401b00608998b4cca34e3e5690b6">sensor_matrix_get_reading</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m, int observer, int robot)</td></tr> |
40 |
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a reading in a sensor matrix. <a href="#gf8f7401b00608998b4cca34e3e5690b6"></a><br></td></tr> |
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga2039902278b82d75157f5ce30ba24a3">sensor_matrix_set_in_ring</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m, int robot, int in)</td></tr> |
43 |
|
44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether the robot is in the token ring. <a href="#ga2039902278b82d75157f5ce30ba24a3"></a><br></td></tr> |
45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g44d31428ed9c7a0c98e2ecfc74a55469">sensor_matrix_get_in_ring</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m, int robot)</td></tr> |
46 |
|
47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get whether the robot is in the sensor ring. <a href="#g44d31428ed9c7a0c98e2ecfc74a55469"></a><br></td></tr> |
48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g1d799b72ee6274e5064e12e8dd17d493">sensor_matrix_get_size</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m)</td></tr> |
49 |
|
50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the sensor matrix. <a href="#g1d799b72ee6274e5064e12e8dd17d493"></a><br></td></tr> |
51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g48353450a17126cffa44bd894f087621">sensor_matrix_get_joined</a> (<a class="el" href="structSensorMatrix.html">SensorMatrix</a> *m)</td></tr> |
52 |
|
53 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of robots which have joined the token ring. <a href="#g48353450a17126cffa44bd894f087621"></a><br></td></tr> |
54 |
</table>
|
55 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
56 |
the robot sensor matrix |
57 |
<p>
|
58 |
These functions and structures are used for localization to determine the relative directions of robots. <hr><h2>Function Documentation</h2> |
59 |
<a class="anchor" name="g4a8cea8d7401802b8ef4f24768671cdb"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_add_robot" ref="g4a8cea8d7401802b8ef4f24768671cdb" args="(SensorMatrix *m, unsigned int id)" --><p> |
60 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
61 |
<tr>
|
62 |
<td class="mdRow"> |
63 |
<table cellpadding="0" cellspacing="0" border="0"> |
64 |
<tr>
|
65 |
<td class="md" nowrap valign="top">void sensor_matrix_add_robot </td> |
66 |
<td class="md" valign="top">( </td> |
67 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
68 |
<td class="mdname" nowrap> <em>m</em>, </td> |
69 |
</tr>
|
70 |
<tr>
|
71 |
<td class="md" nowrap align="right"></td> |
72 |
<td class="md"></td> |
73 |
<td class="md" nowrap>unsigned int </td> |
74 |
<td class="mdname" nowrap> <em>id</em></td> |
75 |
</tr>
|
76 |
<tr>
|
77 |
<td class="md"></td> |
78 |
<td class="md">) </td> |
79 |
<td class="md" colspan="2"></td> |
80 |
</tr>
|
81 |
</table>
|
82 |
</td>
|
83 |
</tr>
|
84 |
</table>
|
85 |
<table cellspacing="5" cellpadding="0" border="0"> |
86 |
<tr>
|
87 |
<td>
|
88 |
|
89 |
</td>
|
90 |
<td>
|
91 |
|
92 |
<p>
|
93 |
Add a robot to a sensor matrix. |
94 |
<p>
|
95 |
Adds robot with XBee id id to the sensor matrix.<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>m</em> </td><td>the sensor matrix </td></tr> |
99 |
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the XBee ID of the robot to add </td></tr> |
100 |
</table>
|
101 |
</dl>
|
102 |
</td>
|
103 |
</tr>
|
104 |
</table>
|
105 |
<a class="anchor" name="gdac971de8e0df3ed469c1e00b5d68ec3"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_create" ref="gdac971de8e0df3ed469c1e00b5d68ec3" args="(void)" --><p> |
106 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
107 |
<tr>
|
108 |
<td class="mdRow"> |
109 |
<table cellpadding="0" cellspacing="0" border="0"> |
110 |
<tr>
|
111 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a>* sensor_matrix_create </td> |
112 |
<td class="md" valign="top">( </td> |
113 |
<td class="md" nowrap valign="top">void </td> |
114 |
<td class="mdname1" valign="top" nowrap> </td> |
115 |
<td class="md" valign="top"> ) </td> |
116 |
<td class="md" nowrap></td> |
117 |
</tr>
|
118 |
</table>
|
119 |
</td>
|
120 |
</tr>
|
121 |
</table>
|
122 |
<table cellspacing="5" cellpadding="0" border="0"> |
123 |
<tr>
|
124 |
<td>
|
125 |
|
126 |
</td>
|
127 |
<td>
|
128 |
|
129 |
<p>
|
130 |
Create a sensor matrix. |
131 |
<p>
|
132 |
Initializes the sensor matrix.<p>
|
133 |
<dl compact><dt><b>Returns:</b></dt><dd>the newly created sensor matrix </dd></dl> |
134 |
</td>
|
135 |
</tr>
|
136 |
</table>
|
137 |
<a class="anchor" name="g6125c1926243c789c9a22c7b7ca915f7"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_destroy" ref="g6125c1926243c789c9a22c7b7ca915f7" args="(SensorMatrix *m)" --><p> |
138 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
139 |
<tr>
|
140 |
<td class="mdRow"> |
141 |
<table cellpadding="0" cellspacing="0" border="0"> |
142 |
<tr>
|
143 |
<td class="md" nowrap valign="top">void sensor_matrix_destroy </td> |
144 |
<td class="md" valign="top">( </td> |
145 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
146 |
<td class="mdname1" valign="top" nowrap> <em>m</em> </td> |
147 |
<td class="md" valign="top"> ) </td> |
148 |
<td class="md" nowrap></td> |
149 |
</tr>
|
150 |
</table>
|
151 |
</td>
|
152 |
</tr>
|
153 |
</table>
|
154 |
<table cellspacing="5" cellpadding="0" border="0"> |
155 |
<tr>
|
156 |
<td>
|
157 |
|
158 |
</td>
|
159 |
<td>
|
160 |
|
161 |
<p>
|
162 |
Destroy a sensor matrix. |
163 |
<p>
|
164 |
Deletes and frees memory from the sensor matrix.<p>
|
165 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
166 |
<table border="0" cellspacing="2" cellpadding="0"> |
167 |
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>the sensor matrix to delete </td></tr> |
168 |
</table>
|
169 |
</dl>
|
170 |
</td>
|
171 |
</tr>
|
172 |
</table>
|
173 |
<a class="anchor" name="g44d31428ed9c7a0c98e2ecfc74a55469"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_in_ring" ref="g44d31428ed9c7a0c98e2ecfc74a55469" args="(SensorMatrix *m, int robot)" --><p> |
174 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
175 |
<tr>
|
176 |
<td class="mdRow"> |
177 |
<table cellpadding="0" cellspacing="0" border="0"> |
178 |
<tr>
|
179 |
<td class="md" nowrap valign="top">int sensor_matrix_get_in_ring </td> |
180 |
<td class="md" valign="top">( </td> |
181 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
182 |
<td class="mdname" nowrap> <em>m</em>, </td> |
183 |
</tr>
|
184 |
<tr>
|
185 |
<td class="md" nowrap align="right"></td> |
186 |
<td class="md"></td> |
187 |
<td class="md" nowrap>int </td> |
188 |
<td class="mdname" nowrap> <em>robot</em></td> |
189 |
</tr>
|
190 |
<tr>
|
191 |
<td class="md"></td> |
192 |
<td class="md">) </td> |
193 |
<td class="md" colspan="2"></td> |
194 |
</tr>
|
195 |
</table>
|
196 |
</td>
|
197 |
</tr>
|
198 |
</table>
|
199 |
<table cellspacing="5" cellpadding="0" border="0"> |
200 |
<tr>
|
201 |
<td>
|
202 |
|
203 |
</td>
|
204 |
<td>
|
205 |
|
206 |
<p>
|
207 |
Get whether the robot is in the sensor ring. |
208 |
<p>
|
209 |
Checks if the given robot is in the token ring.<p>
|
210 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
211 |
<table border="0" cellspacing="2" cellpadding="0"> |
212 |
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>the sensor matrix </td></tr> |
213 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the ID of the robot to check</td></tr> |
214 |
</table>
|
215 |
</dl>
|
216 |
<dl compact><dt><b>Returns:</b></dt><dd>1 if the robot is in the token ring, 0 otherwise </dd></dl> |
217 |
</td>
|
218 |
</tr>
|
219 |
</table>
|
220 |
<a class="anchor" name="g48353450a17126cffa44bd894f087621"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_joined" ref="g48353450a17126cffa44bd894f087621" args="(SensorMatrix *m)" --><p> |
221 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
222 |
<tr>
|
223 |
<td class="mdRow"> |
224 |
<table cellpadding="0" cellspacing="0" border="0"> |
225 |
<tr>
|
226 |
<td class="md" nowrap valign="top">int sensor_matrix_get_joined </td> |
227 |
<td class="md" valign="top">( </td> |
228 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
229 |
<td class="mdname1" valign="top" nowrap> <em>m</em> </td> |
230 |
<td class="md" valign="top"> ) </td> |
231 |
<td class="md" nowrap></td> |
232 |
</tr>
|
233 |
</table>
|
234 |
</td>
|
235 |
</tr>
|
236 |
</table>
|
237 |
<table cellspacing="5" cellpadding="0" border="0"> |
238 |
<tr>
|
239 |
<td>
|
240 |
|
241 |
</td>
|
242 |
<td>
|
243 |
|
244 |
<p>
|
245 |
Get the number of robots which have joined the token ring. |
246 |
<p>
|
247 |
Returns the number of robots which have joined the token ring.<p>
|
248 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
249 |
<table border="0" cellspacing="2" cellpadding="0"> |
250 |
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>the sensor matrix</td></tr> |
251 |
</table>
|
252 |
</dl>
|
253 |
<dl compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl> |
254 |
</td>
|
255 |
</tr>
|
256 |
</table>
|
257 |
<a class="anchor" name="gf8f7401b00608998b4cca34e3e5690b6"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_reading" ref="gf8f7401b00608998b4cca34e3e5690b6" args="(SensorMatrix *m, int observer, int robot)" --><p> |
258 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
259 |
<tr>
|
260 |
<td class="mdRow"> |
261 |
<table cellpadding="0" cellspacing="0" border="0"> |
262 |
<tr>
|
263 |
<td class="md" nowrap valign="top">int sensor_matrix_get_reading </td> |
264 |
<td class="md" valign="top">( </td> |
265 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
266 |
<td class="mdname" nowrap> <em>m</em>, </td> |
267 |
</tr>
|
268 |
<tr>
|
269 |
<td class="md" nowrap align="right"></td> |
270 |
<td class="md"></td> |
271 |
<td class="md" nowrap>int </td> |
272 |
<td class="mdname" nowrap> <em>observer</em>, </td> |
273 |
</tr>
|
274 |
<tr>
|
275 |
<td class="md" nowrap align="right"></td> |
276 |
<td class="md"></td> |
277 |
<td class="md" nowrap>int </td> |
278 |
<td class="mdname" nowrap> <em>robot</em></td> |
279 |
</tr>
|
280 |
<tr>
|
281 |
<td class="md"></td> |
282 |
<td class="md">) </td> |
283 |
<td class="md" colspan="2"></td> |
284 |
</tr>
|
285 |
</table>
|
286 |
</td>
|
287 |
</tr>
|
288 |
</table>
|
289 |
<table cellspacing="5" cellpadding="0" border="0"> |
290 |
<tr>
|
291 |
<td>
|
292 |
|
293 |
</td>
|
294 |
<td>
|
295 |
|
296 |
<p>
|
297 |
Get a reading in a sensor matrix. |
298 |
<p>
|
299 |
Gets the sensor reading for a robot to another robot.<p>
|
300 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
301 |
<table border="0" cellspacing="2" cellpadding="0"> |
302 |
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>the sensor matrix </td></tr> |
303 |
<tr><td valign="top"></td><td valign="top"><em>observer</em> </td><td>the robot whose reading we check </td></tr> |
304 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the robot who we are checking the reading to</td></tr> |
305 |
</table>
|
306 |
</dl>
|
307 |
<dl compact><dt><b>Returns:</b></dt><dd>the observer's BOM reading for robot </dd></dl> |
308 |
</td>
|
309 |
</tr>
|
310 |
</table>
|
311 |
<a class="anchor" name="g1d799b72ee6274e5064e12e8dd17d493"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_size" ref="g1d799b72ee6274e5064e12e8dd17d493" args="(SensorMatrix *m)" --><p> |
312 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
313 |
<tr>
|
314 |
<td class="mdRow"> |
315 |
<table cellpadding="0" cellspacing="0" border="0"> |
316 |
<tr>
|
317 |
<td class="md" nowrap valign="top">int sensor_matrix_get_size </td> |
318 |
<td class="md" valign="top">( </td> |
319 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
320 |
<td class="mdname1" valign="top" nowrap> <em>m</em> </td> |
321 |
<td class="md" valign="top"> ) </td> |
322 |
<td class="md" nowrap></td> |
323 |
</tr>
|
324 |
</table>
|
325 |
</td>
|
326 |
</tr>
|
327 |
</table>
|
328 |
<table cellspacing="5" cellpadding="0" border="0"> |
329 |
<tr>
|
330 |
<td>
|
331 |
|
332 |
</td>
|
333 |
<td>
|
334 |
|
335 |
<p>
|
336 |
Get the size of the sensor matrix. |
337 |
<p>
|
338 |
Returns the size of the sensor matrix.<p>
|
339 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
340 |
<table border="0" cellspacing="2" cellpadding="0"> |
341 |
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>the sensor matrix</td></tr> |
342 |
</table>
|
343 |
</dl>
|
344 |
<dl compact><dt><b>Returns:</b></dt><dd>the size of the sensor matrix </dd></dl> |
345 |
</td>
|
346 |
</tr>
|
347 |
</table>
|
348 |
<a class="anchor" name="g616455f4c0801504984cc7f7cf49d980"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_remove_robot" ref="g616455f4c0801504984cc7f7cf49d980" args="(SensorMatrix *m, unsigned int id)" --><p> |
349 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
350 |
<tr>
|
351 |
<td class="mdRow"> |
352 |
<table cellpadding="0" cellspacing="0" border="0"> |
353 |
<tr>
|
354 |
<td class="md" nowrap valign="top">void sensor_matrix_remove_robot </td> |
355 |
<td class="md" valign="top">( </td> |
356 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
357 |
<td class="mdname" nowrap> <em>m</em>, </td> |
358 |
</tr>
|
359 |
<tr>
|
360 |
<td class="md" nowrap align="right"></td> |
361 |
<td class="md"></td> |
362 |
<td class="md" nowrap>unsigned int </td> |
363 |
<td class="mdname" nowrap> <em>id</em></td> |
364 |
</tr>
|
365 |
<tr>
|
366 |
<td class="md"></td> |
367 |
<td class="md">) </td> |
368 |
<td class="md" colspan="2"></td> |
369 |
</tr>
|
370 |
</table>
|
371 |
</td>
|
372 |
</tr>
|
373 |
</table>
|
374 |
<table cellspacing="5" cellpadding="0" border="0"> |
375 |
<tr>
|
376 |
<td>
|
377 |
|
378 |
</td>
|
379 |
<td>
|
380 |
|
381 |
<p>
|
382 |
Remove a robot from a sensor matrix. |
383 |
<p>
|
384 |
Removes robot with id from the sensor matrix, and removes all sensor information regarding the robot.<p>
|
385 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
386 |
<table border="0" cellspacing="2" cellpadding="0"> |
387 |
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>the sensor matrix </td></tr> |
388 |
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the XBee ID of the robot to remove </td></tr> |
389 |
</table>
|
390 |
</dl>
|
391 |
</td>
|
392 |
</tr>
|
393 |
</table>
|
394 |
<a class="anchor" name="ga2039902278b82d75157f5ce30ba24a3"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_in_ring" ref="ga2039902278b82d75157f5ce30ba24a3" args="(SensorMatrix *m, int robot, int in)" --><p> |
395 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
396 |
<tr>
|
397 |
<td class="mdRow"> |
398 |
<table cellpadding="0" cellspacing="0" border="0"> |
399 |
<tr>
|
400 |
<td class="md" nowrap valign="top">void sensor_matrix_set_in_ring </td> |
401 |
<td class="md" valign="top">( </td> |
402 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
403 |
<td class="mdname" nowrap> <em>m</em>, </td> |
404 |
</tr>
|
405 |
<tr>
|
406 |
<td class="md" nowrap align="right"></td> |
407 |
<td class="md"></td> |
408 |
<td class="md" nowrap>int </td> |
409 |
<td class="mdname" nowrap> <em>robot</em>, </td> |
410 |
</tr>
|
411 |
<tr>
|
412 |
<td class="md" nowrap align="right"></td> |
413 |
<td class="md"></td> |
414 |
<td class="md" nowrap>int </td> |
415 |
<td class="mdname" nowrap> <em>in</em></td> |
416 |
</tr>
|
417 |
<tr>
|
418 |
<td class="md"></td> |
419 |
<td class="md">) </td> |
420 |
<td class="md" colspan="2"></td> |
421 |
</tr>
|
422 |
</table>
|
423 |
</td>
|
424 |
</tr>
|
425 |
</table>
|
426 |
<table cellspacing="5" cellpadding="0" border="0"> |
427 |
<tr>
|
428 |
<td>
|
429 |
|
430 |
</td>
|
431 |
<td>
|
432 |
|
433 |
<p>
|
434 |
Set whether the robot is in the token ring. |
435 |
<p>
|
436 |
Sets whether or not the given robot is part of the token ring.<p>
|
437 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
438 |
<table border="0" cellspacing="2" cellpadding="0"> |
439 |
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>the sensor matrix </td></tr> |
440 |
<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> |
441 |
<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> |
442 |
</table>
|
443 |
</dl>
|
444 |
</td>
|
445 |
</tr>
|
446 |
</table>
|
447 |
<a class="anchor" name="g06977570b0c7b9628caeb5de012bbf22"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_reading" ref="g06977570b0c7b9628caeb5de012bbf22" args="(SensorMatrix *m, int observer, int robot, int reading)" --><p> |
448 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
449 |
<tr>
|
450 |
<td class="mdRow"> |
451 |
<table cellpadding="0" cellspacing="0" border="0"> |
452 |
<tr>
|
453 |
<td class="md" nowrap valign="top">void sensor_matrix_set_reading </td> |
454 |
<td class="md" valign="top">( </td> |
455 |
<td class="md" nowrap valign="top"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> * </td> |
456 |
<td class="mdname" nowrap> <em>m</em>, </td> |
457 |
</tr>
|
458 |
<tr>
|
459 |
<td class="md" nowrap align="right"></td> |
460 |
<td class="md"></td> |
461 |
<td class="md" nowrap>int </td> |
462 |
<td class="mdname" nowrap> <em>observer</em>, </td> |
463 |
</tr>
|
464 |
<tr>
|
465 |
<td class="md" nowrap align="right"></td> |
466 |
<td class="md"></td> |
467 |
<td class="md" nowrap>int </td> |
468 |
<td class="mdname" nowrap> <em>robot</em>, </td> |
469 |
</tr>
|
470 |
<tr>
|
471 |
<td class="md" nowrap align="right"></td> |
472 |
<td class="md"></td> |
473 |
<td class="md" nowrap>int </td> |
474 |
<td class="mdname" nowrap> <em>reading</em></td> |
475 |
</tr>
|
476 |
<tr>
|
477 |
<td class="md"></td> |
478 |
<td class="md">) </td> |
479 |
<td class="md" colspan="2"></td> |
480 |
</tr>
|
481 |
</table>
|
482 |
</td>
|
483 |
</tr>
|
484 |
</table>
|
485 |
<table cellspacing="5" cellpadding="0" border="0"> |
486 |
<tr>
|
487 |
<td>
|
488 |
|
489 |
</td>
|
490 |
<td>
|
491 |
|
492 |
<p>
|
493 |
Set a reading in a sensor matrix. |
494 |
<p>
|
495 |
Sets the sensor reading for robot robot to reading.<p>
|
496 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
497 |
<table border="0" cellspacing="2" cellpadding="0"> |
498 |
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>the sensor matrix to set the reading for </td></tr> |
499 |
<tr><td valign="top"></td><td valign="top"><em>observer</em> </td><td>the id of the robot who made the reading </td></tr> |
500 |
<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> |
501 |
<tr><td valign="top"></td><td valign="top"><em>reading</em> </td><td>the BOM reading from observer to robot </td></tr> |
502 |
</table>
|
503 |
</dl>
|
504 |
</td>
|
505 |
</tr>
|
506 |
</table>
|
507 |
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 24 14:12:31 2007 for libwireless by |
508 |
<a href="http://www.doxygen.org/index.html"> |
509 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
510 |
</body>
|
511 |
</html>
|