Project

General

Profile

Revision 737

Added by Brian Coltin almost 16 years ago

Updated wireless documentation.

View differences:

group__sensormatrix.html
21 21 

  		




  22
  22
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html">SensorMatrix</a></td></tr>


  		




  23
  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> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gdac971de8e0df3ed469c1e00b5d68ec3">sensor_matrix_create</a> (void)</td></tr>


  		




  
  24
  
    
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>


  		




  
  25
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g90947d420e328af375fda40c9b199b7d"></a><!-- doxytag: member="sensormatrix::MAXIMUM_XBEE_ID" ref="g90947d420e328af375fda40c9b199b7d" args="" -->


  		




  
  26
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MAXIMUM_XBEE_ID</b>&nbsp;&nbsp;&nbsp;0x10</td></tr>


  		




  26
  27
  
    

  		




  27
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  28
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g782ef5f54e97435c631329a5e536f680"></a><!-- doxytag: member="sensormatrix::READING_UNKNOWN" ref="g782ef5f54e97435c631329a5e536f680" args="" -->


  		




  
  29
  
    
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>READING_UNKNOWN</b>&nbsp;&nbsp;&nbsp;0xFF</td></tr>


  		




  29
  30
  
    

  		




  30
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  31
  
    
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


  		




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


  		




  32
  33
  
    

  		




  33
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  34
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a sensor matrix.  <a href="#g09523e52546e7929288795e1e5f0f9a8"></a><br></td></tr>


  		




  
  35
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gf251d97aeb23af9156c0527692819da7">sensor_matrix_set_reading</a> (int observer, int robot, int reading)</td></tr>


  		




  35
  36
  
    

  		




  36
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  37
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a reading in a sensor matrix.  <a href="#gf251d97aeb23af9156c0527692819da7"></a><br></td></tr>


  		




  
  38
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g031d5a4d15603e57379aad22da36e300">sensor_matrix_get_reading</a> (int observer, int robot)</td></tr>


  		




  38
  39
  
    

  		




  39
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  40
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a reading in a sensor matrix.  <a href="#g031d5a4d15603e57379aad22da36e300"></a><br></td></tr>


  		




  
  41
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gea879c1d5f8a8a079066d8df005f3549">sensor_matrix_set_in_ring</a> (int robot, int in)</td></tr>


  		




  41
  42
  
    

  		




  42
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  43
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set whether the robot is in the token ring.  <a href="#gea879c1d5f8a8a079066d8df005f3549"></a><br></td></tr>


  		




  
  44
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gc668dfe28e56b5a314789d395eda3b27">sensor_matrix_get_in_ring</a> (int robot)</td></tr>


  		




  44
  45
  
    

  		




  45
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  46
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get whether the robot is in the sensor ring.  <a href="#gc668dfe28e56b5a314789d395eda3b27"></a><br></td></tr>


  		




  
  47
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#g3545800eec0adba2fc63604206b8fb24">sensor_matrix_get_joined</a> (void)</td></tr>


  		




  47
  48
  
    

  		




  48
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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>


  		




  
  49
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of robots which have joined the token ring.  <a href="#g3545800eec0adba2fc63604206b8fb24"></a><br></td></tr>


  		




  
  50
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga22a0851d1886ca29fc32e0692502f2d">sensor_matrix_get_size</a> (void)</td></tr>


  		




  50
  51
  
    

  		




  51
  
  
    
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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">&nbsp;</td><td class="mdescRight">Get the number of robots which have joined the token ring.  <a href="#g48353450a17126cffa44bd894f087621"></a><br></td></tr>


  		




  
  52
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum size of the sensor matrix.  <a href="#ga22a0851d1886ca29fc32e0692502f2d"></a><br></td></tr>


  		




  55
  53
  
    
</table>


  		




  56
  54
  
    
<hr><a name="_details"></a><h2>Detailed Description</h2>


  		




  57
  55
  
    
the robot sensor matrix 


  		




  58
  56
  
    
<p>


  		




  59
  57
  
    
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)" -->


  		




  
  58
  
    
<a class="anchor" name="g09523e52546e7929288795e1e5f0f9a8"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_create" ref="g09523e52546e7929288795e1e5f0f9a8" args="(void)" -->


  		




  61
  59
  
    
<div class="memitem">


  		




  62
  60
  
    
<div class="memproto">


  		




  63
  61
  
    
      <table class="memname">


  		




  64
  62
  
    
        <tr>


  		




  65
  
  
    
          <td class="memname">void sensor_matrix_add_robot           </td>


  		




  
  63
  
    
          <td class="memname">void sensor_matrix_create           </td>


  		




  66
  64
  
    
          <td>(</td>


  		




  67
  
  
    
          <td class="paramtype"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> *&nbsp;</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&nbsp;</td>


  		




  74
  
  
    
          <td class="paramname"> <em>id</em></td><td>&nbsp;</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>&nbsp;</td><td>the sensor matrix </td></tr>


  		




  92
  
  
    
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</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
  65
  
    
          <td class="paramtype">void&nbsp;</td>


  		




  106
  66
  
    
          <td class="paramname">          </td>


  		




  107
  67
  
    
          <td>&nbsp;)&nbsp;</td>


  		




  ......




  119
  79
  
    

  		




  120
  80
  
    
</div>


  		




  121
  81
  
    
</div><p>


  		




  122
  
  
    
<a class="anchor" name="g6125c1926243c789c9a22c7b7ca915f7"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_destroy" ref="g6125c1926243c789c9a22c7b7ca915f7" args="(SensorMatrix *m)" -->


  		




  
  82
  
    
<a class="anchor" name="gc668dfe28e56b5a314789d395eda3b27"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_in_ring" ref="gc668dfe28e56b5a314789d395eda3b27" args="(int robot)" -->


  		




  123
  83
  
    
<div class="memitem">


  		




  124
  84
  
    
<div class="memproto">


  		




  125
  85
  
    
      <table class="memname">


  		




  126
  86
  
    
        <tr>


  		




  127
  
  
    
          <td class="memname">void sensor_matrix_destroy           </td>


  		




  
  87
  
    
          <td class="memname">int sensor_matrix_get_in_ring           </td>


  		




  128
  88
  
    
          <td>(</td>


  		




  129
  
  
    
          <td class="paramtype"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> *&nbsp;</td>


  		




  130
  
  
    
          <td class="paramname"> <em>m</em>          </td>


  		




  
  89
  
    
          <td class="paramtype">int&nbsp;</td>


  		




  
  90
  
    
          <td class="paramname"> <em>robot</em>          </td>


  		




  131
  91
  
    
          <td>&nbsp;)&nbsp;</td>


  		




  132
  92
  
    
          <td width="100%"></td>


  		




  133
  93
  
    
        </tr>


  		




  ......




  136
  96
  
    
<div class="memdoc">


  		




  137
  97
  
    

  		




  138
  98
  
    
<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>&nbsp;</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> *&nbsp;</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&nbsp;</td>


  		




  164
  
  
    
          <td class="paramname"> <em>robot</em></td><td>&nbsp;</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
  99
  
    
Get whether the robot is in the sensor ring. 


  		




  177
  100
  
    
<p>


  		




  178
  101
  
    
Checks if the given robot is in the token ring.<p>


  		




  179
  102
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  180
  103
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  181
  
  
    
    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>the sensor matrix </td></tr>


  		




  182
  104
  
    
    <tr><td valign="top"></td><td valign="top"><em>robot</em>&nbsp;</td><td>the ID of the robot to check</td></tr>


  		




  183
  105
  
    
  </table>


  		




  184
  106
  
    
</dl>


  		




  ......




  186
  108
  
    

  		




  187
  109
  
    
</div>


  		




  188
  110
  
    
</div><p>


  		




  189
  
  
    
<a class="anchor" name="g48353450a17126cffa44bd894f087621"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_joined" ref="g48353450a17126cffa44bd894f087621" args="(SensorMatrix *m)" -->


  		




  
  111
  
    
<a class="anchor" name="g3545800eec0adba2fc63604206b8fb24"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_joined" ref="g3545800eec0adba2fc63604206b8fb24" args="(void)" -->


  		




  190
  112
  
    
<div class="memitem">


  		




  191
  113
  
    
<div class="memproto">


  		




  192
  114
  
    
      <table class="memname">


  		




  193
  115
  
    
        <tr>


  		




  194
  116
  
    
          <td class="memname">int sensor_matrix_get_joined           </td>


  		




  195
  117
  
    
          <td>(</td>


  		




  196
  
  
    
          <td class="paramtype"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> *&nbsp;</td>


  		




  197
  
  
    
          <td class="paramname"> <em>m</em>          </td>


  		




  
  118
  
    
          <td class="paramtype">void&nbsp;</td>


  		




  
  119
  
    
          <td class="paramname">          </td>


  		




  198
  120
  
    
          <td>&nbsp;)&nbsp;</td>


  		




  199
  121
  
    
          <td width="100%"></td>


  		




  200
  122
  
    
        </tr>


  		




  ......




  206
  128
  
    
Get the number of robots which have joined the token ring. 


  		




  207
  129
  
    
<p>


  		




  208
  130
  
    
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>&nbsp;</td><td>the sensor matrix</td></tr>


  		




  212
  
  
    
  </table>


  		




  213
  
  
    
</dl>


  		




  214
  131
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl>


  		




  215
  132
  
    

  		




  216
  133
  
    
</div>


  		




  217
  134
  
    
</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)" -->


  		




  
  135
  
    
<a class="anchor" name="g031d5a4d15603e57379aad22da36e300"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_reading" ref="g031d5a4d15603e57379aad22da36e300" args="(int observer, int robot)" -->


  		




  219
  136
  
    
<div class="memitem">


  		




  220
  137
  
    
<div class="memproto">


  		




  221
  138
  
    
      <table class="memname">


  		




  222
  139
  
    
        <tr>


  		




  223
  140
  
    
          <td class="memname">int sensor_matrix_get_reading           </td>


  		




  224
  141
  
    
          <td>(</td>


  		




  225
  
  
    
          <td class="paramtype"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> *&nbsp;</td>


  		




  226
  
  
    
          <td class="paramname"> <em>m</em>, </td>


  		




  227
  
  
    
        </tr>


  		




  228
  
  
    
        <tr>


  		




  229
  
  
    
          <td class="paramkey"></td>


  		




  230
  
  
    
          <td></td>


  		




  231
  142
  
    
          <td class="paramtype">int&nbsp;</td>


  		




  232
  143
  
    
          <td class="paramname"> <em>observer</em>, </td>


  		




  233
  144
  
    
        </tr>


  		




  ......




  252
  163
  
    
Gets the sensor reading for a robot to another robot.<p>


  		




  253
  164
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  254
  165
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  255
  
  
    
    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>the sensor matrix </td></tr>


  		




  256
  166
  
    
    <tr><td valign="top"></td><td valign="top"><em>observer</em>&nbsp;</td><td>the robot whose reading we check </td></tr>


  		




  257
  167
  
    
    <tr><td valign="top"></td><td valign="top"><em>robot</em>&nbsp;</td><td>the robot who we are checking the reading to</td></tr>


  		




  258
  168
  
    
  </table>


  		




  ......




  261
  171
  
    

  		




  262
  172
  
    
</div>


  		




  263
  173
  
    
</div><p>


  		




  264
  
  
    
<a class="anchor" name="g1d799b72ee6274e5064e12e8dd17d493"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_size" ref="g1d799b72ee6274e5064e12e8dd17d493" args="(SensorMatrix *m)" -->


  		




  
  174
  
    
<a class="anchor" name="ga22a0851d1886ca29fc32e0692502f2d"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_size" ref="ga22a0851d1886ca29fc32e0692502f2d" args="(void)" -->


  		




  265
  175
  
    
<div class="memitem">


  		




  266
  176
  
    
<div class="memproto">


  		




  267
  177
  
    
      <table class="memname">


  		




  268
  178
  
    
        <tr>


  		




  269
  179
  
    
          <td class="memname">int sensor_matrix_get_size           </td>


  		




  270
  180
  
    
          <td>(</td>


  		




  271
  
  
    
          <td class="paramtype"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> *&nbsp;</td>


  		




  272
  
  
    
          <td class="paramname"> <em>m</em>          </td>


  		




  
  181
  
    
          <td class="paramtype">void&nbsp;</td>


  		




  
  182
  
    
          <td class="paramname">          </td>


  		




  273
  183
  
    
          <td>&nbsp;)&nbsp;</td>


  		




  274
  
  
    
          <td width="100%"></td>


  		




  
  184
  
    
          <td width="100%"><code> [inline]</code></td>


  		




  275
  185
  
    
        </tr>


  		




  276
  186
  
    
      </table>


  		




  277
  187
  
    
</div>


  		




  278
  188
  
    
<div class="memdoc">


  		




  279
  189
  
    

  		




  280
  190
  
    
<p>


  		




  281
  
  
    
Get the size of the sensor matrix. 


  		




  
  191
  
    
Get the maximum size of the sensor matrix. 


  		




  282
  192
  
    
<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>&nbsp;</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>


  		




  
  193
  
    
Returns the maximum XBee id of a robot which can be stored in the sensor matrix.<p>


  		




  
  194
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the maximum number of robots which can be stored </dd></dl>


  		




  290
  195
  
    

  		




  291
  196
  
    
</div>


  		




  292
  197
  
    
</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)" -->


  		




  
  198
  
    
<a class="anchor" name="gea879c1d5f8a8a079066d8df005f3549"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_in_ring" ref="gea879c1d5f8a8a079066d8df005f3549" args="(int robot, int in)" -->


  		




  294
  199
  
    
<div class="memitem">


  		




  295
  200
  
    
<div class="memproto">


  		




  296
  201
  
    
      <table class="memname">


  		




  297
  202
  
    
        <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> *&nbsp;</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&nbsp;</td>


  		




  307
  
  
    
          <td class="paramname"> <em>id</em></td><td>&nbsp;</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>&nbsp;</td><td>the sensor matrix </td></tr>


  		




  325
  
  
    
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</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
  203
  
    
          <td class="memname">void sensor_matrix_set_in_ring           </td>


  		




  337
  204
  
    
          <td>(</td>


  		




  338
  
  
    
          <td class="paramtype"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> *&nbsp;</td>


  		




  339
  
  
    
          <td class="paramname"> <em>m</em>, </td>


  		




  340
  
  
    
        </tr>


  		




  341
  
  
    
        <tr>


  		




  342
  
  
    
          <td class="paramkey"></td>


  		




  343
  
  
    
          <td></td>


  		




  344
  205
  
    
          <td class="paramtype">int&nbsp;</td>


  		




  345
  206
  
    
          <td class="paramname"> <em>robot</em>, </td>


  		




  346
  207
  
    
        </tr>


  		




  ......




  365
  226
  
    
Sets whether or not the given robot is part of the token ring.<p>


  		




  366
  227
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




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


  		




  368
  
  
    
    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>the sensor matrix </td></tr>


  		




  369
  229
  
    
    <tr><td valign="top"></td><td valign="top"><em>robot</em>&nbsp;</td><td>the robot to set as a member / nonmember of the token ring </td></tr>


  		




  370
  230
  
    
    <tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>1 if the robot is in the token ring, 0 otherwise </td></tr>


  		




  371
  231
  
    
  </table>


  		




  ......




  373
  233
  
    

  		




  374
  234
  
    
</div>


  		




  375
  235
  
    
</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)" -->


  		




  
  236
  
    
<a class="anchor" name="gf251d97aeb23af9156c0527692819da7"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_reading" ref="gf251d97aeb23af9156c0527692819da7" args="(int observer, int robot, int reading)" -->


  		




  377
  237
  
    
<div class="memitem">


  		




  378
  238
  
    
<div class="memproto">


  		




  379
  239
  
    
      <table class="memname">


  		




  380
  240
  
    
        <tr>


  		




  381
  241
  
    
          <td class="memname">void sensor_matrix_set_reading           </td>


  		




  382
  242
  
    
          <td>(</td>


  		




  383
  
  
    
          <td class="paramtype"><a class="el" href="structSensorMatrix.html">SensorMatrix</a> *&nbsp;</td>


  		




  384
  
  
    
          <td class="paramname"> <em>m</em>, </td>


  		




  385
  
  
    
        </tr>


  		




  386
  
  
    
        <tr>


  		




  387
  
  
    
          <td class="paramkey"></td>


  		




  388
  
  
    
          <td></td>


  		




  389
  243
  
    
          <td class="paramtype">int&nbsp;</td>


  		




  390
  244
  
    
          <td class="paramname"> <em>observer</em>, </td>


  		




  391
  245
  
    
        </tr>


  		




  ......




  416
  270
  
    
Sets the sensor reading for robot robot to reading.<p>


  		




  417
  271
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  418
  272
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  419
  
  
    
    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>the sensor matrix to set the reading for </td></tr>


  		




  420
  273
  
    
    <tr><td valign="top"></td><td valign="top"><em>observer</em>&nbsp;</td><td>the id of the robot who made the reading </td></tr>


  		




  421
  274
  
    
    <tr><td valign="top"></td><td valign="top"><em>robot</em>&nbsp;</td><td>the id of the robot who the reading is for </td></tr>


  		




  422
  275
  
    
    <tr><td valign="top"></td><td valign="top"><em>reading</em>&nbsp;</td><td>the BOM reading from observer to robot </td></tr>


  		




  ......




  425
  278
  
    

  		




  426
  279
  
    
</div>


  		




  427
  280
  
    
</div><p>


  		




  428
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:23 2007 for libwireless by&nbsp;


  		




  
  281
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;


  		




  429
  282
  
    
<a href="http://www.doxygen.org/index.html">


  		




  430
  283
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>


  		




  431
  284
  
    
</body>


  		












Also available in:  Unified diff