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