Project

General

Profile

Revision 79

Added by Chris Mar over 16 years ago

tried to merge lib_additions again...

View differences:

group__tokenring.html
34 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 35 

  		




  36
  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
  
    
<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
  
    

  		




  
  39
  
    
<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>


  		




  
  40
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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>


  		




  
  41
  
    

  		




  
  42
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return whether a given robot is in the token ring.  <a href="#g14e005f0b9582eca7e3585f247c4cd72"></a><br></td></tr>


  		




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


  		




  
  44
  
    

  		




  
  45
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Begin iterating through robots in the token ring.  <a href="#g37ab9fb00e9eef273b4d0fcda81a2620"></a><br></td></tr>


  		




  
  46
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a> (void)</td></tr>


  		




  
  47
  
    

  		




  
  48
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether there are more robots to iterate through.  <a href="#gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><br></td></tr>


  		




  
  49
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> (void)</td></tr>


  		




  
  50
  
    

  		




  
  51
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the ID of the next robot in the token ring.  <a href="#gd9196324178877770d8ffc91d40893c3"></a><br></td></tr>


  		




  37
  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#gb4afd4b8e034d22d415f3c4a42a652fc">wl_token_get_sensor_reading</a> (int source, int dest)</td></tr>


  		




  38
  53
  
    

  		




  39
  54
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the latest BOM reading between two robots.  <a href="#gb4afd4b8e034d22d415f3c4a42a652fc"></a><br></td></tr>


  		




  40
  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#g1938c1d79dd9438dcd413d6d26372877">wl_token_get_my_sensor_reading</a> (int dest)</td></tr>


  		




  41
  56
  
    

  		




  42
  57
  
    
<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>


  		




  
  60
  
    

  		




  
  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>


  		




  
  64
  
    

  		




  
  65
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of non-null elements in the sensor matrix. <br></td></tr>


  		




  43
  66
  
    
</table>


  		




  44
  67
  
    
<hr><a name="_details"></a><h2>Detailed Description</h2>


  		




  45
  68
  
    
Wireless library token ring implementation. 


  		




  ......




  82
  105
  
    
    </td>


  		




  83
  106
  
    
  </tr>


  		




  84
  107
  
    
</table>


  		




  
  108
  
    
<a class="anchor" name="g0c61bb8892aa5513706e00cd8ce5ca8b"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_robots_in_ring" ref="g0c61bb8892aa5513706e00cd8ce5ca8b" args="(void)" --><p>


  		




  
  109
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  
  110
  
    
  <tr>


  		




  
  111
  
    
    <td class="mdRow">


  		




  
  112
  
    
      <table cellpadding="0" cellspacing="0" border="0">


  		




  
  113
  
    
        <tr>


  		




  
  114
  
    
          <td class="md" nowrap valign="top">int wl_token_get_robots_in_ring           </td>


  		




  
  115
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  
  116
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  
  117
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  
  118
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  
  119
  
    
          <td class="md" nowrap></td>


  		




  
  120
  
    
        </tr>


  		




  
  121
  
    
      </table>


  		




  
  122
  
    
    </td>


  		




  
  123
  
    
  </tr>


  		




  
  124
  
    
</table>


  		




  
  125
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  
  126
  
    
  <tr>


  		




  
  127
  
    
    <td>


  		




  
  128
  
    
      &nbsp;


  		




  
  129
  
    
    </td>


  		




  
  130
  
    
    <td>


  		




  
  131
  
    

  		




  
  132
  
    
<p>


  		




  
  133
  
    
Return the number of robots in the token ring. 


  		




  
  134
  
    
<p>


  		




  
  135
  
    
Returns the number of robots in the token ring.<p>


  		




  
  136
  
    
<dl compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl>


  		




  
  137
  
    
    </td>


  		




  
  138
  
    
  </tr>


  		




  
  139
  
    
</table>


  		




  85
  140
  
    
<a class="anchor" name="gb4afd4b8e034d22d415f3c4a42a652fc"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_sensor_reading" ref="gb4afd4b8e034d22d415f3c4a42a652fc" args="(int source, int dest)" --><p>


  		




  86
  141
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  87
  142
  
    
  <tr>


  		




  ......




  129
  184
  
    
    </td>


  		




  130
  185
  
    
  </tr>


  		




  131
  186
  
    
</table>


  		




  
  187
  
    
<a class="anchor" name="g14e005f0b9582eca7e3585f247c4cd72"></a><!-- doxytag: member="wl_token_ring.h::wl_token_is_robot_in_ring" ref="g14e005f0b9582eca7e3585f247c4cd72" args="(int robot)" --><p>


  		




  
  188
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  
  189
  
    
  <tr>


  		




  
  190
  
    
    <td class="mdRow">


  		




  
  191
  
    
      <table cellpadding="0" cellspacing="0" border="0">


  		




  
  192
  
    
        <tr>


  		




  
  193
  
    
          <td class="md" nowrap valign="top">int wl_token_is_robot_in_ring           </td>


  		




  
  194
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  
  195
  
    
          <td class="md" nowrap valign="top">int&nbsp;</td>


  		




  
  196
  
    
          <td class="mdname1" valign="top" nowrap> <em>robot</em>          </td>


  		




  
  197
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  
  198
  
    
          <td class="md" nowrap></td>


  		




  
  199
  
    
        </tr>


  		




  
  200
  
    
      </table>


  		




  
  201
  
    
    </td>


  		




  
  202
  
    
  </tr>


  		




  
  203
  
    
</table>


  		




  
  204
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  
  205
  
    
  <tr>


  		




  
  206
  
    
    <td>


  		




  
  207
  
    
      &nbsp;


  		




  
  208
  
    
    </td>


  		




  
  209
  
    
    <td>


  		




  
  210
  
    

  		




  
  211
  
    
<p>


  		




  
  212
  
    
Return whether a given robot is in the token ring. 


  		




  
  213
  
    
<p>


  		




  
  214
  
    
Returns true if the specified robot is in the token ring, false otherwise.<p>


  		




  
  215
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  
  216
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  
  217
  
    
    <tr><td valign="top"></td><td valign="top"><em>robot</em>&nbsp;</td><td>the robot to check for whether it is in the token ring </td></tr>


  		




  
  218
  
    
  </table>


  		




  
  219
  
    
</dl>


  		




  
  220
  
    
<dl compact><dt><b>Returns:</b></dt><dd>nonzero if the robot is in the token ring, zero otherwise </dd></dl>


  		




  
  221
  
    
    </td>


  		




  
  222
  
    
  </tr>


  		




  
  223
  
    
</table>


  		




  
  224
  
    
<a class="anchor" name="g37ab9fb00e9eef273b4d0fcda81a2620"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_begin" ref="g37ab9fb00e9eef273b4d0fcda81a2620" args="(void)" --><p>


  		




  
  225
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  
  226
  
    
  <tr>


  		




  
  227
  
    
    <td class="mdRow">


  		




  
  228
  
    
      <table cellpadding="0" cellspacing="0" border="0">


  		




  
  229
  
    
        <tr>


  		




  
  230
  
    
          <td class="md" nowrap valign="top">void wl_token_iterator_begin           </td>


  		




  
  231
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  
  232
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  
  233
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  
  234
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  
  235
  
    
          <td class="md" nowrap></td>


  		




  
  236
  
    
        </tr>


  		




  
  237
  
    
      </table>


  		




  
  238
  
    
    </td>


  		




  
  239
  
    
  </tr>


  		




  
  240
  
    
</table>


  		




  
  241
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  
  242
  
    
  <tr>


  		




  
  243
  
    
    <td>


  		




  
  244
  
    
      &nbsp;


  		




  
  245
  
    
    </td>


  		




  
  246
  
    
    <td>


  		




  
  247
  
    

  		




  
  248
  
    
<p>


  		




  
  249
  
    
Begin iterating through robots in the token ring. 


  		




  
  250
  
    
<p>


  		




  
  251
  
    
Begins iterating through the robots in the token ring.<p>


  		




  
  252
  
    
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a>, <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> </dd></dl>


  		




  
  253
  
    
    </td>


  		




  
  254
  
    
  </tr>


  		




  
  255
  
    
</table>


  		




  
  256
  
    
<a class="anchor" name="gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_has_next" ref="gbd7dc40ee796a67e1160b2b2b8e7d02f" args="(void)" --><p>


  		




  
  257
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  
  258
  
    
  <tr>


  		




  
  259
  
    
    <td class="mdRow">


  		




  
  260
  
    
      <table cellpadding="0" cellspacing="0" border="0">


  		




  
  261
  
    
        <tr>


  		




  
  262
  
    
          <td class="md" nowrap valign="top">int wl_token_iterator_has_next           </td>


  		




  
  263
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  
  264
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  
  265
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  
  266
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  
  267
  
    
          <td class="md" nowrap></td>


  		




  
  268
  
    
        </tr>


  		




  
  269
  
    
      </table>


  		




  
  270
  
    
    </td>


  		




  
  271
  
    
  </tr>


  		




  
  272
  
    
</table>


  		




  
  273
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  
  274
  
    
  <tr>


  		




  
  275
  
    
    <td>


  		




  
  276
  
    
      &nbsp;


  		




  
  277
  
    
    </td>


  		




  
  278
  
    
    <td>


  		




  
  279
  
    

  		




  
  280
  
    
<p>


  		




  
  281
  
    
Returns whether there are more robots to iterate through. 


  		




  
  282
  
    
<p>


  		




  
  283
  
    
Returns true if there are more robots in the token ring to iterate through, and false otherwise.<p>


  		




  
  284
  
    
<dl compact><dt><b>Returns:</b></dt><dd>nonzero if there are more robots to iterate through, zero otherwise</dd></dl>


  		




  
  285
  
    
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a>, <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> </dd></dl>


  		




  
  286
  
    
    </td>


  		




  
  287
  
    
  </tr>


  		




  
  288
  
    
</table>


  		




  
  289
  
    
<a class="anchor" name="gd9196324178877770d8ffc91d40893c3"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_next" ref="gd9196324178877770d8ffc91d40893c3" args="(void)" --><p>


  		




  
  290
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  
  291
  
    
  <tr>


  		




  
  292
  
    
    <td class="mdRow">


  		




  
  293
  
    
      <table cellpadding="0" cellspacing="0" border="0">


  		




  
  294
  
    
        <tr>


  		




  
  295
  
    
          <td class="md" nowrap valign="top">int wl_token_iterator_next           </td>


  		




  
  296
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  
  297
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  
  298
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  
  299
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  
  300
  
    
          <td class="md" nowrap></td>


  		




  
  301
  
    
        </tr>


  		




  
  302
  
    
      </table>


  		




  
  303
  
    
    </td>


  		




  
  304
  
    
  </tr>


  		




  
  305
  
    
</table>


  		




  
  306
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  
  307
  
    
  <tr>


  		




  
  308
  
    
    <td>


  		




  
  309
  
    
      &nbsp;


  		




  
  310
  
    
    </td>


  		




  
  311
  
    
    <td>


  		




  
  312
  
    

  		




  
  313
  
    
<p>


  		




  
  314
  
    
Returns the ID of the next robot in the token ring. 


  		




  
  315
  
    
<p>


  		




  
  316
  
    
Returns the next robot ID in the token ring.<p>


  		




  
  317
  
    
<dl compact><dt><b>Returns:</b></dt><dd>the next robot ID in the token ring, or -1 if none exists</dd></dl>


  		




  
  318
  
    
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a>, <a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a> </dd></dl>


  		




  
  319
  
    
    </td>


  		




  
  320
  
    
  </tr>


  		




  
  321
  
    
</table>


  		




  132
  322
  
    
<a class="anchor" name="g23b4e34098b6fc32dc55ccab7fe17b5b"></a><!-- doxytag: member="wl_token_ring.h::wl_token_request" ref="g23b4e34098b6fc32dc55ccab7fe17b5b" args="(int robot)" --><p>


  		




  133
  323
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  134
  324
  
    
  <tr>


  		




  ......




  338
  528
  
    
Removes the packet group from the wireless library.     </td>


  		




  339
  529
  
    
  </tr>


  		




  340
  530
  
    
</table>


  		




  341
  
  
    
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 10 22:13:04 2007 for libwireless by&nbsp;


  		




  
  531
  
    
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 24 14:12:31 2007 for libwireless by&nbsp;


  		




  342
  532
  
    
<a href="http://www.doxygen.org/index.html">


  		




  343
  533
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>


  		




  344
  534
  
    
</body>


  		












Also available in:  Unified diff