Project

General

Profile

Revision 192

Updated wireless documentation.

View differences:

group__tokenring.html
31 31
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a">wl_token_ring_leave</a> (void)</td></tr>
32 32

  
33 33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Leave the token ring.  <a href="#g6c2dd8742e100f63d4fb002707d1e85a"></a><br></td></tr>
34
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g23b4e34098b6fc32dc55ccab7fe17b5b">wl_token_request</a> (int robot)</td></tr>
35

  
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request a BOM flash from the specified robot.  <a href="#g23b4e34098b6fc32dc55ccab7fe17b5b"></a><br></td></tr>
37 34
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b">wl_token_get_robots_in_ring</a> (void)</td></tr>
38 35

  
39 36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of robots in the token ring.  <a href="#g0c61bb8892aa5513706e00cd8ce5ca8b"></a><br></td></tr>
......
55 52
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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>
56 53

  
57 54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the latest BOM reading between us and another robot.  <a href="#g1938c1d79dd9438dcd413d6d26372877"></a><br></td></tr>
58
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf0d311d4feae71afc8bcb0b8c8e6ba57"></a><!-- doxytag: member="tokenring::wl_token_get_num_robots" ref="gf0d311d4feae71afc8bcb0b8c8e6ba57" args="(void)" -->
59
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57">wl_token_get_num_robots</a> (void)</td></tr>
55
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57">wl_token_get_num_robots</a> (void)</td></tr>
60 56

  
61
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of robots in the sensor matrix. <br></td></tr>
62
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5fe1508968d450a970b0d5417a06431d"></a><!-- doxytag: member="tokenring::wl_token_get_matrix_size" ref="g5fe1508968d450a970b0d5417a06431d" args="(void)" -->
63
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d">wl_token_get_matrix_size</a> (void)</td></tr>
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of robots in the sensor matrix.  <a href="#gf0d311d4feae71afc8bcb0b8c8e6ba57"></a><br></td></tr>
58
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d">wl_token_get_matrix_size</a> (void)</td></tr>
64 59

  
65
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of non-null elements in the sensor matrix. <br></td></tr>
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of non-null elements in the sensor matrix.  <a href="#g5fe1508968d450a970b0d5417a06431d"></a><br></td></tr>
66 61
</table>
67 62
<hr><a name="_details"></a><h2>Detailed Description</h2>
68 63
Wireless library token ring implementation. 
69 64
<p>
70 65
This packet group is used to form a token ring, which keeps track of the relative directions of the robots from one another. <hr><h2>Function Documentation</h2>
66
<a class="anchor" name="g5fe1508968d450a970b0d5417a06431d"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_matrix_size" ref="g5fe1508968d450a970b0d5417a06431d" args="(void)" --><p>
67
<table class="mdTable" cellpadding="2" cellspacing="0">
68
  <tr>
69
    <td class="mdRow">
70
      <table cellpadding="0" cellspacing="0" border="0">
71
        <tr>
72
          <td class="md" nowrap valign="top">int wl_token_get_matrix_size           </td>
73
          <td class="md" valign="top">(&nbsp;</td>
74
          <td class="md" nowrap valign="top">void&nbsp;</td>
75
          <td class="mdname1" valign="top" nowrap>          </td>
76
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
77
          <td class="md" nowrap></td>
78
        </tr>
79
      </table>
80
    </td>
81
  </tr>
82
</table>
83
<table cellspacing="5" cellpadding="0" border="0">
84
  <tr>
85
    <td>
86
      &nbsp;
87
    </td>
88
    <td>
89

  
90
<p>
91
Return the number of non-null elements in the sensor matrix. 
92
<p>
93
Returns the number of robots in the sensor matrix.<p>
94
<dl compact><dt><b>Returns:</b></dt><dd>the number of robots in the sensor matrix </dd></dl>
95
    </td>
96
  </tr>
97
</table>
71 98
<a class="anchor" name="g1938c1d79dd9438dcd413d6d26372877"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_my_sensor_reading" ref="g1938c1d79dd9438dcd413d6d26372877" args="(int dest)" --><p>
72 99
<table class="mdTable" cellpadding="2" cellspacing="0">
73 100
  <tr>
......
105 132
    </td>
106 133
  </tr>
107 134
</table>
135
<a class="anchor" name="gf0d311d4feae71afc8bcb0b8c8e6ba57"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_num_robots" ref="gf0d311d4feae71afc8bcb0b8c8e6ba57" args="(void)" --><p>
136
<table class="mdTable" cellpadding="2" cellspacing="0">
137
  <tr>
138
    <td class="mdRow">
139
      <table cellpadding="0" cellspacing="0" border="0">
140
        <tr>
141
          <td class="md" nowrap valign="top">int wl_token_get_num_robots           </td>
142
          <td class="md" valign="top">(&nbsp;</td>
143
          <td class="md" nowrap valign="top">void&nbsp;</td>
144
          <td class="mdname1" valign="top" nowrap>          </td>
145
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
146
          <td class="md" nowrap></td>
147
        </tr>
148
      </table>
149
    </td>
150
  </tr>
151
</table>
152
<table cellspacing="5" cellpadding="0" border="0">
153
  <tr>
154
    <td>
155
      &nbsp;
156
    </td>
157
    <td>
158

  
159
<p>
160
Return the number of robots in the sensor matrix. 
161
<p>
162
Returns the number of robots currently in the token ring.<p>
163
<dl compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl>
164
    </td>
165
  </tr>
166
</table>
108 167
<a class="anchor" name="g0c61bb8892aa5513706e00cd8ce5ca8b"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_robots_in_ring" ref="g0c61bb8892aa5513706e00cd8ce5ca8b" args="(void)" --><p>
109 168
<table class="mdTable" cellpadding="2" cellspacing="0">
110 169
  <tr>
......
319 378
    </td>
320 379
  </tr>
321 380
</table>
322
<a class="anchor" name="g23b4e34098b6fc32dc55ccab7fe17b5b"></a><!-- doxytag: member="wl_token_ring.h::wl_token_request" ref="g23b4e34098b6fc32dc55ccab7fe17b5b" args="(int robot)" --><p>
323
<table class="mdTable" cellpadding="2" cellspacing="0">
324
  <tr>
325
    <td class="mdRow">
326
      <table cellpadding="0" cellspacing="0" border="0">
327
        <tr>
328
          <td class="md" nowrap valign="top">void wl_token_request           </td>
329
          <td class="md" valign="top">(&nbsp;</td>
330
          <td class="md" nowrap valign="top">int&nbsp;</td>
331
          <td class="mdname1" valign="top" nowrap> <em>robot</em>          </td>
332
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
333
          <td class="md" nowrap></td>
334
        </tr>
335
      </table>
336
    </td>
337
  </tr>
338
</table>
339
<table cellspacing="5" cellpadding="0" border="0">
340
  <tr>
341
    <td>
342
      &nbsp;
343
    </td>
344
    <td>
345

  
346
<p>
347
Request a BOM flash from the specified robot. 
348
<p>
349
Requests that the specified robot be given the token and allowed to flash its BOM. After its BOM is flashed, the token will return to the robot who sent it.<p>
350
<dl compact><dt><b>Parameters:</b></dt><dd>
351
  <table border="0" cellspacing="2" cellpadding="0">
352
    <tr><td valign="top"></td><td valign="top"><em>robot</em>&nbsp;</td><td>the ID of the robot which should flash its BOM </td></tr>
353
  </table>
354
</dl>
355
    </td>
356
  </tr>
357
</table>
358 381
<a class="anchor" name="gbdb1e2258d1c69086692d2d31e02fb27"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_join" ref="gbdb1e2258d1c69086692d2d31e02fb27" args="(void)" --><p>
359 382
<table class="mdTable" cellpadding="2" cellspacing="0">
360 383
  <tr>
......
528 551
Removes the packet group from the wireless library.     </td>
529 552
  </tr>
530 553
</table>
531
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 24 14:12:31 2007 for libwireless by&nbsp;
554
<hr size="1"><address style="align: right;"><small>Generated on Wed Oct 31 17:54:43 2007 for libwireless by&nbsp;
532 555
<a href="http://www.doxygen.org/index.html">
533 556
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
534 557
</body>

Also available in: Unified diff