Revision 1380
fixed doxygen problems in wireless library, added new docs
| group__sensormatrix.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: Sensor Matrix</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>Sensor Matrix</h1>the robot sensor matrix |
| 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>Data Structures</h2></td></tr> |
| 20 | 25 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html">SensorMatrix</a></td></tr> |
| 21 | 26 |
|
| 22 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html">SensorMatrix</a></td></tr> |
|
| 23 |
|
|
| 24 | 27 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 25 | 28 |
<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 | 29 |
#define </td><td class="memItemRight" valign="bottom"><b>MAXIMUM_XBEE_ID</b> 0x10</td></tr> |
| ... | ... | |
| 65 | 68 |
<td class="paramtype">void </td> |
| 66 | 69 |
<td class="paramname"> </td> |
| 67 | 70 |
<td> ) </td> |
| 68 |
<td width="100%"></td>
|
|
| 71 |
<td></td> |
|
| 69 | 72 |
</tr> |
| 70 | 73 |
</table> |
| 71 | 74 |
</div> |
| ... | ... | |
| 77 | 80 |
Initializes the sensor matrix.<p> |
| 78 | 81 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the newly created sensor matrix </dd></dl> |
| 79 | 82 |
|
| 83 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00070">SensorMatrix::joined</a>, <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>, and <a class="el" href="sensor__matrix_8h_source.html#l00065">SensorMatrix::numJoined</a>.</p> |
|
| 84 |
|
|
| 85 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p> |
|
| 86 |
|
|
| 80 | 87 |
</div> |
| 81 | 88 |
</div><p> |
| 82 | 89 |
<a class="anchor" name="gc668dfe28e56b5a314789d395eda3b27"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_in_ring" ref="gc668dfe28e56b5a314789d395eda3b27" args="(int robot)" --> |
| ... | ... | |
| 89 | 96 |
<td class="paramtype">int </td> |
| 90 | 97 |
<td class="paramname"> <em>robot</em> </td> |
| 91 | 98 |
<td> ) </td> |
| 92 |
<td width="100%"></td>
|
|
| 99 |
<td></td> |
|
| 93 | 100 |
</tr> |
| 94 | 101 |
</table> |
| 95 | 102 |
</div> |
| ... | ... | |
| 106 | 113 |
</dl> |
| 107 | 114 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the robot is in the token ring, 0 otherwise </dd></dl> |
| 108 | 115 |
|
| 116 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00070">SensorMatrix::joined</a>.</p> |
|
| 117 |
|
|
| 118 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00394">wl_token_is_robot_in_ring()</a>, <a class="el" href="wl__token__ring_8c_source.html#l00404">wl_token_iterator_begin()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00446">wl_token_iterator_next()</a>.</p> |
|
| 119 |
|
|
| 109 | 120 |
</div> |
| 110 | 121 |
</div><p> |
| 111 | 122 |
<a class="anchor" name="g3545800eec0adba2fc63604206b8fb24"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_joined" ref="g3545800eec0adba2fc63604206b8fb24" args="(void)" --> |
| ... | ... | |
| 118 | 129 |
<td class="paramtype">void </td> |
| 119 | 130 |
<td class="paramname"> </td> |
| 120 | 131 |
<td> ) </td> |
| 121 |
<td width="100%"></td>
|
|
| 132 |
<td></td> |
|
| 122 | 133 |
</tr> |
| 123 | 134 |
</table> |
| 124 | 135 |
</div> |
| ... | ... | |
| 130 | 141 |
Returns the number of robots which have joined the token ring.<p> |
| 131 | 142 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl> |
| 132 | 143 |
|
| 144 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00065">SensorMatrix::numJoined</a>.</p> |
|
| 145 |
|
|
| 146 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00478">wl_token_get_num_robots()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00380">wl_token_get_robots_in_ring()</a>.</p> |
|
| 147 |
|
|
| 133 | 148 |
</div> |
| 134 | 149 |
</div><p> |
| 135 | 150 |
<a class="anchor" name="g031d5a4d15603e57379aad22da36e300"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_reading" ref="g031d5a4d15603e57379aad22da36e300" args="(int observer, int robot)" --> |
| ... | ... | |
| 151 | 166 |
<tr> |
| 152 | 167 |
<td></td> |
| 153 | 168 |
<td>)</td> |
| 154 |
<td></td><td></td><td width="100%"></td>
|
|
| 169 |
<td></td><td></td><td></td> |
|
| 155 | 170 |
</tr> |
| 156 | 171 |
</table> |
| 157 | 172 |
</div> |
| ... | ... | |
| 169 | 184 |
</dl> |
| 170 | 185 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the observer's BOM reading for robot </dd></dl> |
| 171 | 186 |
|
| 187 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>.</p> |
|
| 188 |
|
|
| 189 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00347">wl_token_get_sensor_reading()</a>.</p> |
|
| 190 |
|
|
| 172 | 191 |
</div> |
| 173 | 192 |
</div><p> |
| 174 | 193 |
<a class="anchor" name="ga22a0851d1886ca29fc32e0692502f2d"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_size" ref="ga22a0851d1886ca29fc32e0692502f2d" args="(void)" --> |
| ... | ... | |
| 181 | 200 |
<td class="paramtype">void </td> |
| 182 | 201 |
<td class="paramname"> </td> |
| 183 | 202 |
<td> ) </td> |
| 184 |
<td width="100%"><code> [inline]</code></td>
|
|
| 203 |
<td></td> |
|
| 185 | 204 |
</tr> |
| 186 | 205 |
</table> |
| 187 | 206 |
</div> |
| ... | ... | |
| 193 | 212 |
Returns the maximum XBee id of a robot which can be stored in the sensor matrix.<p> |
| 194 | 213 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the maximum number of robots which can be stored </dd></dl> |
| 195 | 214 |
|
| 215 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00490">wl_token_get_matrix_size()</a>, <a class="el" href="wl__token__ring_8c_source.html#l00404">wl_token_iterator_begin()</a>, and <a class="el" href="wl__token__ring_8c_source.html#l00446">wl_token_iterator_next()</a>.</p> |
|
| 216 |
|
|
| 196 | 217 |
</div> |
| 197 | 218 |
</div><p> |
| 198 | 219 |
<a class="anchor" name="gea879c1d5f8a8a079066d8df005f3549"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_in_ring" ref="gea879c1d5f8a8a079066d8df005f3549" args="(int robot, int in)" --> |
| ... | ... | |
| 214 | 235 |
<tr> |
| 215 | 236 |
<td></td> |
| 216 | 237 |
<td>)</td> |
| 217 |
<td></td><td></td><td width="100%"></td>
|
|
| 238 |
<td></td><td></td><td></td> |
|
| 218 | 239 |
</tr> |
| 219 | 240 |
</table> |
| 220 | 241 |
</div> |
| ... | ... | |
| 231 | 252 |
</table> |
| 232 | 253 |
</dl> |
| 233 | 254 |
|
| 255 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00070">SensorMatrix::joined</a>, and <a class="el" href="sensor__matrix_8h_source.html#l00065">SensorMatrix::numJoined</a>.</p> |
|
| 256 |
|
|
| 257 |
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p> |
|
| 258 |
|
|
| 234 | 259 |
</div> |
| 235 | 260 |
</div><p> |
| 236 | 261 |
<a class="anchor" name="gf251d97aeb23af9156c0527692819da7"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_reading" ref="gf251d97aeb23af9156c0527692819da7" args="(int observer, int robot, int reading)" --> |
| ... | ... | |
| 258 | 283 |
<tr> |
| 259 | 284 |
<td></td> |
| 260 | 285 |
<td>)</td> |
| 261 |
<td></td><td></td><td width="100%"></td>
|
|
| 286 |
<td></td><td></td><td></td> |
|
| 262 | 287 |
</tr> |
| 263 | 288 |
</table> |
| 264 | 289 |
</div> |
| ... | ... | |
| 276 | 301 |
</table> |
| 277 | 302 |
</dl> |
| 278 | 303 |
|
| 304 |
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>.</p> |
|
| 305 |
|
|
| 279 | 306 |
</div> |
| 280 | 307 |
</div><p> |
| 281 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by |
|
| 308 |
</div> |
|
| 309 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by |
|
| 282 | 310 |
<a href="http://www.doxygen.org/index.html"> |
| 283 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
| 311 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 284 | 312 |
</body> |
| 285 | 313 |
</html> |
Also available in: Unified diff