Revision 1380
fixed doxygen problems in wireless library, added new docs
| group__tokenring.html | ||
|---|---|---|
| 1 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 | 3 |
<title>libwireless: Token Ring</title> |
| 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
| 4 | 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
| 6 | 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> |
|
| 7 |
<!-- Generated by Doxygen 1.5.9 --> |
|
| 8 |
<div class="navigation" id="top"> |
|
| 9 |
<div class="tabs"> |
|
| 10 |
<ul> |
|
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
| 12 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
| 13 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
| 14 |
<li><a href="files.html"><span>Files</span></a></li> |
|
| 15 |
</ul> |
|
| 16 |
</div> |
|
| 15 | 17 |
</div> |
| 18 |
<div class="contents"> |
|
| 16 | 19 |
<h1>Token Ring</h1>Wireless library token ring implementation. |
| 17 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 20 |
<a href="#_details">More...</a> |
|
| 21 |
<p> |
|
| 22 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 18 | 23 |
<tr><td></td></tr> |
| 19 | 24 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 20 | 25 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g00fb5cca21a50d39aa1e82fdc679ca44">wl_token_ring_register</a> (void)</td></tr> |
| ... | ... | |
| 74 | 79 |
<td class="paramtype">void </td> |
| 75 | 80 |
<td class="paramname"> </td> |
| 76 | 81 |
<td> ) </td> |
| 77 |
<td width="100%"></td>
|
|
| 82 |
<td></td> |
|
| 78 | 83 |
</tr> |
| 79 | 84 |
</table> |
| 80 | 85 |
</div> |
| ... | ... | |
| 86 | 91 |
Returns the number of robots in the sensor matrix.<p> |
| 87 | 92 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the sensor matrix </dd></dl> |
| 88 | 93 |
|
| 94 |
<p>References <a class="el" href="sensor__matrix_8c_source.html#l00159">sensor_matrix_get_size()</a>.</p> |
|
| 95 |
|
|
| 89 | 96 |
</div> |
| 90 | 97 |
</div><p> |
| 91 | 98 |
<a class="anchor" name="g1938c1d79dd9438dcd413d6d26372877"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_my_sensor_reading" ref="g1938c1d79dd9438dcd413d6d26372877" args="(int dest)" --> |
| ... | ... | |
| 98 | 105 |
<td class="paramtype">int </td> |
| 99 | 106 |
<td class="paramname"> <em>dest</em> </td> |
| 100 | 107 |
<td> ) </td> |
| 101 |
<td width="100%"></td>
|
|
| 108 |
<td></td> |
|
| 102 | 109 |
</tr> |
| 103 | 110 |
</table> |
| 104 | 111 |
</div> |
| ... | ... | |
| 115 | 122 |
</dl> |
| 116 | 123 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a BOM reading from us to robot dest, in the range 0-15, or -1 if it is unkown </dd></dl> |
| 117 | 124 |
|
| 125 |
<p>References <a class="el" href="wireless_8c_source.html#l00235">wl_get_xbee_id()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00347">wl_token_get_sensor_reading()</a>.</p> |
|
| 126 |
|
|
| 118 | 127 |
</div> |
| 119 | 128 |
</div><p> |
| 120 | 129 |
<a class="anchor" name="gf0d311d4feae71afc8bcb0b8c8e6ba57"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_num_robots" ref="gf0d311d4feae71afc8bcb0b8c8e6ba57" args="(void)" --> |
| ... | ... | |
| 127 | 136 |
<td class="paramtype">void </td> |
| 128 | 137 |
<td class="paramname"> </td> |
| 129 | 138 |
<td> ) </td> |
| 130 |
<td width="100%"></td>
|
|
| 139 |
<td></td> |
|
| 131 | 140 |
</tr> |
| 132 | 141 |
</table> |
| 133 | 142 |
</div> |
| ... | ... | |
| 139 | 148 |
Returns the number of robots currently in the token ring.<p> |
| 140 | 149 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl> |
| 141 | 150 |
|
| 151 |
<p>References <a class="el" href="sensor__matrix_8c_source.html#l00148">sensor_matrix_get_joined()</a>.</p> |
|
| 152 |
|
|
| 142 | 153 |
</div> |
| 143 | 154 |
</div><p> |
| 144 | 155 |
<a class="anchor" name="g0c61bb8892aa5513706e00cd8ce5ca8b"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_robots_in_ring" ref="g0c61bb8892aa5513706e00cd8ce5ca8b" args="(void)" --> |
| ... | ... | |
| 151 | 162 |
<td class="paramtype">void </td> |
| 152 | 163 |
<td class="paramname"> </td> |
| 153 | 164 |
<td> ) </td> |
| 154 |
<td width="100%"></td>
|
|
| 165 |
<td></td> |
|
| 155 | 166 |
</tr> |
| 156 | 167 |
</table> |
| 157 | 168 |
</div> |
| ... | ... | |
| 163 | 174 |
Returns the number of robots in the token ring.<p> |
| 164 | 175 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl> |
| 165 | 176 |
|
| 177 |
<p>References <a class="el" href="sensor__matrix_8c_source.html#l00148">sensor_matrix_get_joined()</a>.</p> |
|
| 178 |
|
|
| 166 | 179 |
</div> |
| 167 | 180 |
</div><p> |
| 168 | 181 |
<a class="anchor" name="gb4afd4b8e034d22d415f3c4a42a652fc"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_sensor_reading" ref="gb4afd4b8e034d22d415f3c4a42a652fc" args="(int source, int dest)" --> |
| ... | ... | |
| 184 | 197 |
<tr> |
| 185 | 198 |
<td></td> |
| 186 | 199 |
<td>)</td> |
| 187 |
<td></td><td></td><td width="100%"></td>
|
|
| 200 |
<td></td><td></td><td></td> |
|
| 188 | 201 |
</tr> |
| 189 | 202 |
</table> |
| 190 | 203 |
</div> |
| ... | ... | |
| 202 | 215 |
</dl> |
| 203 | 216 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a BOM reading from robot source to robot dest, in the range 0-15, or -1 if it is unknown </dd></dl> |
| 204 | 217 |
|
| 218 |
<p>References <a class="el" href="sensor__matrix_8c_source.html#l00093">sensor_matrix_get_reading()</a>, <a class="el" href="wireless_8c_source.html#l00235">wl_get_xbee_id()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00394">wl_token_is_robot_in_ring()</a>.</p> |
|
| 219 |
|
|
| 220 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00367">wl_token_get_my_sensor_reading()</a>.</p> |
|
| 221 |
|
|
| 205 | 222 |
</div> |
| 206 | 223 |
</div><p> |
| 207 | 224 |
<a class="anchor" name="g14e005f0b9582eca7e3585f247c4cd72"></a><!-- doxytag: member="wl_token_ring.h::wl_token_is_robot_in_ring" ref="g14e005f0b9582eca7e3585f247c4cd72" args="(int robot)" --> |
| ... | ... | |
| 214 | 231 |
<td class="paramtype">int </td> |
| 215 | 232 |
<td class="paramname"> <em>robot</em> </td> |
| 216 | 233 |
<td> ) </td> |
| 217 |
<td width="100%"></td>
|
|
| 234 |
<td></td> |
|
| 218 | 235 |
</tr> |
| 219 | 236 |
</table> |
| 220 | 237 |
</div> |
| ... | ... | |
| 231 | 248 |
</dl> |
| 232 | 249 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nonzero if the robot is in the token ring, zero otherwise </dd></dl> |
| 233 | 250 |
|
| 251 |
<p>References <a class="el" href="sensor__matrix_8c_source.html#l00134">sensor_matrix_get_in_ring()</a>.</p> |
|
| 252 |
|
|
| 253 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00347">wl_token_get_sensor_reading()</a>.</p> |
|
| 254 |
|
|
| 234 | 255 |
</div> |
| 235 | 256 |
</div><p> |
| 236 | 257 |
<a class="anchor" name="g37ab9fb00e9eef273b4d0fcda81a2620"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_begin" ref="g37ab9fb00e9eef273b4d0fcda81a2620" args="(void)" --> |
| ... | ... | |
| 243 | 264 |
<td class="paramtype">void </td> |
| 244 | 265 |
<td class="paramname"> </td> |
| 245 | 266 |
<td> ) </td> |
| 246 |
<td width="100%"></td>
|
|
| 267 |
<td></td> |
|
| 247 | 268 |
</tr> |
| 248 | 269 |
</table> |
| 249 | 270 |
</div> |
| ... | ... | |
| 255 | 276 |
Begins iterating through the robots in the token ring.<p> |
| 256 | 277 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f" title="Returns whether there are more robots to iterate through.">wl_token_iterator_has_next</a>, <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3" title="Returns the ID of the next robot in the token ring.">wl_token_iterator_next</a> </dd></dl> |
| 257 | 278 |
|
| 279 |
<p>References <a class="el" href="sensor__matrix_8c_source.html#l00134">sensor_matrix_get_in_ring()</a>, and <a class="el" href="sensor__matrix_8c_source.html#l00159">sensor_matrix_get_size()</a>.</p> |
|
| 280 |
|
|
| 258 | 281 |
</div> |
| 259 | 282 |
</div><p> |
| 260 | 283 |
<a class="anchor" name="gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_has_next" ref="gbd7dc40ee796a67e1160b2b2b8e7d02f" args="(void)" --> |
| ... | ... | |
| 267 | 290 |
<td class="paramtype">void </td> |
| 268 | 291 |
<td class="paramname"> </td> |
| 269 | 292 |
<td> ) </td> |
| 270 |
<td width="100%"></td>
|
|
| 293 |
<td></td> |
|
| 271 | 294 |
</tr> |
| 272 | 295 |
</table> |
| 273 | 296 |
</div> |
| ... | ... | |
| 292 | 315 |
<td class="paramtype">void </td> |
| 293 | 316 |
<td class="paramname"> </td> |
| 294 | 317 |
<td> ) </td> |
| 295 |
<td width="100%"></td>
|
|
| 318 |
<td></td> |
|
| 296 | 319 |
</tr> |
| 297 | 320 |
</table> |
| 298 | 321 |
</div> |
| ... | ... | |
| 305 | 328 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the next robot ID in the token ring, or -1 if none exists</dd></dl> |
| 306 | 329 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620" title="Begin iterating through robots in the token ring.">wl_token_iterator_begin</a>, <a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f" title="Returns whether there are more robots to iterate through.">wl_token_iterator_has_next</a> </dd></dl> |
| 307 | 330 |
|
| 331 |
<p>References <a class="el" href="sensor__matrix_8c_source.html#l00134">sensor_matrix_get_in_ring()</a>, and <a class="el" href="sensor__matrix_8c_source.html#l00159">sensor_matrix_get_size()</a>.</p> |
|
| 332 |
|
|
| 308 | 333 |
</div> |
| 309 | 334 |
</div><p> |
| 310 | 335 |
<a class="anchor" name="ge1012b6d6c1c46b26a6c6da7e4ec7c88"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_join" ref="ge1012b6d6c1c46b26a6c6da7e4ec7c88" args="(void)" --> |
| ... | ... | |
| 317 | 342 |
<td class="paramtype">void </td> |
| 318 | 343 |
<td class="paramname"> </td> |
| 319 | 344 |
<td> ) </td> |
| 320 |
<td width="100%"></td>
|
|
| 345 |
<td></td> |
|
| 321 | 346 |
</tr> |
| 322 | 347 |
</table> |
| 323 | 348 |
</div> |
| ... | ... | |
| 327 | 352 |
Join the token ring. |
| 328 | 353 |
<p> |
| 329 | 354 |
Causes the robot to join an existing token ring, or create one if no token ring exists. The token ring uses global and robot to robot packets, and does not rely on any PAN. |
| 355 |
<p>References <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p> |
|
| 356 |
|
|
| 330 | 357 |
</div> |
| 331 | 358 |
</div><p> |
| 332 | 359 |
<a class="anchor" name="g6c2dd8742e100f63d4fb002707d1e85a"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_leave" ref="g6c2dd8742e100f63d4fb002707d1e85a" args="(void)" --> |
| ... | ... | |
| 339 | 366 |
<td class="paramtype">void </td> |
| 340 | 367 |
<td class="paramname"> </td> |
| 341 | 368 |
<td> ) </td> |
| 342 |
<td width="100%"></td>
|
|
| 369 |
<td></td> |
|
| 343 | 370 |
</tr> |
| 344 | 371 |
</table> |
| 345 | 372 |
</div> |
| ... | ... | |
| 361 | 388 |
<td class="paramtype">void </td> |
| 362 | 389 |
<td class="paramname"> </td> |
| 363 | 390 |
<td> ) </td> |
| 364 |
<td width="100%"></td>
|
|
| 391 |
<td></td> |
|
| 365 | 392 |
</tr> |
| 366 | 393 |
</table> |
| 367 | 394 |
</div> |
| ... | ... | |
| 371 | 398 |
Register the token ring group with the wireless library. |
| 372 | 399 |
<p> |
| 373 | 400 |
Initialize the token ring packet group and register it with the wireless library. The robot will not join a token ring. |
| 401 |
<p>References <a class="el" href="sensor__matrix_8c_source.html#l00049">sensor_matrix_create()</a>, <a class="el" href="sensor__matrix_8c_source.html#l00111">sensor_matrix_set_in_ring()</a>, <a class="el" href="wireless_8c_source.html#l00235">wl_get_xbee_id()</a>, and <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p> |
|
| 402 |
|
|
| 374 | 403 |
</div> |
| 375 | 404 |
</div><p> |
| 376 | 405 |
<a class="anchor" name="g0c407d5c215a97d58c67006bcc6e53ce"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_set_bom_functions" ref="g0c407d5c215a97d58c67006bcc6e53ce" args="(void(*on_function)(void), void(*off_function)(void), int(*max_bom_function)(void))" --> |
| ... | ... | |
| 398 | 427 |
<tr> |
| 399 | 428 |
<td></td> |
| 400 | 429 |
<td>)</td> |
| 401 |
<td></td><td></td><td width="100%"></td>
|
|
| 430 |
<td></td><td></td><td></td> |
|
| 402 | 431 |
</tr> |
| 403 | 432 |
</table> |
| 404 | 433 |
</div> |
| ... | ... | |
| 428 | 457 |
<td class="paramtype">void </td> |
| 429 | 458 |
<td class="paramname"> </td> |
| 430 | 459 |
<td> ) </td> |
| 431 |
<td width="100%"></td>
|
|
| 460 |
<td></td> |
|
| 432 | 461 |
</tr> |
| 433 | 462 |
</table> |
| 434 | 463 |
</div> |
| ... | ... | |
| 438 | 467 |
Unregister the token ring group with the wirelss library. |
| 439 | 468 |
<p> |
| 440 | 469 |
Removes the packet group from the wireless library. |
| 470 |
<p>References <a class="el" href="wireless_8c_source.html#l00362">wl_unregister_packet_group()</a>.</p> |
|
| 471 |
|
|
| 441 | 472 |
</div> |
| 442 | 473 |
</div><p> |
| 443 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by |
|
| 474 |
</div> |
|
| 475 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by |
|
| 444 | 476 |
<a href="http://www.doxygen.org/index.html"> |
| 445 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
| 477 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 446 | 478 |
</body> |
| 447 | 479 |
</html> |
Also available in: Unified diff