root / trunk / docs / libwireless / wl__token__ring_8h.html @ 192
History | View | Annotate | Download (7.76 KB)
1 | 19 | bcoltin | <!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: wl_token_ring.h File Reference</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 id="current"><a href="files.html"><span>Files</span></a></li> |
||
14 | </ul></div> |
||
15 | <div class="tabs"> |
||
16 | <ul>
|
||
17 | <li><a href="files.html"><span>File List</span></a></li> |
||
18 | <li><a href="globals.html"><span>Globals</span></a></li> |
||
19 | </ul></div> |
||
20 | <h1>wl_token_ring.h File Reference</h1>Declarations for the token ring packet group. <a href="#_details">More...</a> |
||
21 | <p>
|
||
22 | |||
23 | <p>
|
||
24 | <a href="wl__token__ring_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
25 | <tr><td></td></tr> |
||
26 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
27 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g7bfd97ec1f89b442b278bbcddc6b6ee1">wl_token_ring_register</a> (void)</td></tr> |
||
28 | |||
29 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Register the token ring group with the wireless library. <a href="group__tokenring.html#g7bfd97ec1f89b442b278bbcddc6b6ee1"></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__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e">wl_token_ring_unregister</a> (void)</td></tr> |
||
31 | |||
32 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister the token ring group with the wirelss library. <a href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e"></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__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce">wl_token_ring_set_bom_functions</a> (void(*on_function)(void), void(*off_function)(void), int(*max_bom_function)(void))</td></tr> |
||
34 | |||
35 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the functions called to turn the bom on and off. <a href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce"></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__tokenring.html#gbdb1e2258d1c69086692d2d31e02fb27">wl_token_ring_join</a> (void)</td></tr> |
||
37 | |||
38 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Join the token ring. <a href="group__tokenring.html#gbdb1e2258d1c69086692d2d31e02fb27"></a><br></td></tr> |
||
39 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a">wl_token_ring_leave</a> (void)</td></tr> |
||
40 | |||
41 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Leave the token ring. <a href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a"></a><br></td></tr> |
||
42 | 52 | bcoltin | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b">wl_token_get_robots_in_ring</a> (void)</td></tr> |
43 | |||
44 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of robots in the token ring. <a href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b"></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__tokenring.html#g14e005f0b9582eca7e3585f247c4cd72">wl_token_is_robot_in_ring</a> (int robot)</td></tr> |
||
46 | |||
47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether a given robot is in the token ring. <a href="group__tokenring.html#g14e005f0b9582eca7e3585f247c4cd72"></a><br></td></tr> |
||
48 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a> (void)</td></tr> |
||
49 | |||
50 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Begin iterating through robots in the token ring. <a href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620"></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__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a> (void)</td></tr> |
||
52 | |||
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether there are more robots to iterate through. <a href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><br></td></tr> |
||
54 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> (void)</td></tr> |
||
55 | |||
56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID of the next robot in the token ring. <a href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3"></a><br></td></tr> |
||
57 | 19 | bcoltin | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gb4afd4b8e034d22d415f3c4a42a652fc">wl_token_get_sensor_reading</a> (int source, int dest)</td></tr> |
58 | |||
59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the latest BOM reading between two robots. <a href="group__tokenring.html#gb4afd4b8e034d22d415f3c4a42a652fc"></a><br></td></tr> |
||
60 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g1938c1d79dd9438dcd413d6d26372877">wl_token_get_my_sensor_reading</a> (int dest)</td></tr> |
||
61 | |||
62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the latest BOM reading between us and another robot. <a href="group__tokenring.html#g1938c1d79dd9438dcd413d6d26372877"></a><br></td></tr> |
||
63 | 192 | bcoltin | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57">wl_token_get_num_robots</a> (void)</td></tr> |
64 | 60 | bcoltin | |
65 | 192 | bcoltin | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of robots in the sensor matrix. <a href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57"></a><br></td></tr> |
66 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d">wl_token_get_matrix_size</a> (void)</td></tr> |
||
67 | 60 | bcoltin | |
68 | 192 | bcoltin | <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of non-null elements in the sensor matrix. <a href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d"></a><br></td></tr> |
69 | 19 | bcoltin | </table>
|
70 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
71 | Declarations for the token ring packet group. |
||
72 | <p>
|
||
73 | Contains declarations for the token ring packet group.<p>
|
||
74 | <dl compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl> |
||
75 | 192 | bcoltin | <hr size="1"><address style="align: right;"><small>Generated on Wed Oct 31 17:54:43 2007 for libwireless by |
76 | 19 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
77 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
||
78 | </body>
|
||
79 | </html> |