Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / group__sensormatrix.html @ 1427

History | View | Annotate | Download (14.9 KB)

1 1425 cmar
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
<head>
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 19 bcoltin
<title>libwireless: Sensor Matrix</title>
6 1425 cmar
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
</head>
9
<body>
10
<!-- Generated by Doxygen 1.6.1 -->
11 1380 cmar
<div class="navigation" id="top">
12
  <div class="tabs">
13
    <ul>
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17
      <li><a href="files.html"><span>Files</span></a></li>
18
    </ul>
19
  </div>
20 241 bcoltin
</div>
21 1380 cmar
<div class="contents">
22 1425 cmar
<h1>Sensor Matrix</h1>
23
<p>the robot sensor matrix
24
<a href="#_details">More...</a></p>
25 1380 cmar
<table border="0" cellpadding="0" cellspacing="0">
26 1425 cmar
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
27
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html">SensorMatrix</a></td></tr>
28
<tr><td colspan="2"><h2>Defines</h2></td></tr>
29
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga90947d420e328af375fda40c9b199b7d"></a><!-- doxytag: member="sensormatrix::MAXIMUM_XBEE_ID" ref="ga90947d420e328af375fda40c9b199b7d" args="" -->
30 737 bcoltin
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MAXIMUM_XBEE_ID</b>&nbsp;&nbsp;&nbsp;0x10</td></tr>
31 1425 cmar
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga782ef5f54e97435c631329a5e536f680"></a><!-- doxytag: member="sensormatrix::READING_UNKNOWN" ref="ga782ef5f54e97435c631329a5e536f680" args="" -->
32 737 bcoltin
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>READING_UNKNOWN</b>&nbsp;&nbsp;&nbsp;0xFF</td></tr>
33 1425 cmar
<tr><td colspan="2"><h2>Functions</h2></td></tr>
34
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga09523e52546e7929288795e1e5f0f9a8">sensor_matrix_create</a> (void)</td></tr>
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a sensor matrix.  <a href="#ga09523e52546e7929288795e1e5f0f9a8"></a><br/></td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaf251d97aeb23af9156c0527692819da7">sensor_matrix_set_reading</a> (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="#gaf251d97aeb23af9156c0527692819da7"></a><br/></td></tr>
38
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga031d5a4d15603e57379aad22da36e300">sensor_matrix_get_reading</a> (int observer, int robot)</td></tr>
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a reading in a sensor matrix.  <a href="#ga031d5a4d15603e57379aad22da36e300"></a><br/></td></tr>
40
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaea879c1d5f8a8a079066d8df005f3549">sensor_matrix_set_in_ring</a> (int robot, int in)</td></tr>
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set whether the robot is in the token ring.  <a href="#gaea879c1d5f8a8a079066d8df005f3549"></a><br/></td></tr>
42
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gac668dfe28e56b5a314789d395eda3b27">sensor_matrix_get_in_ring</a> (int robot)</td></tr>
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get whether the robot is in the sensor ring.  <a href="#gac668dfe28e56b5a314789d395eda3b27"></a><br/></td></tr>
44
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#ga3545800eec0adba2fc63604206b8fb24">sensor_matrix_get_joined</a> (void)</td></tr>
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of robots which have joined the token ring.  <a href="#ga3545800eec0adba2fc63604206b8fb24"></a><br/></td></tr>
46
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sensormatrix.html#gaa22a0851d1886ca29fc32e0692502f2d">sensor_matrix_get_size</a> (void)</td></tr>
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum size of the sensor matrix.  <a href="#gaa22a0851d1886ca29fc32e0692502f2d"></a><br/></td></tr>
48 19 bcoltin
</table>
49 1425 cmar
<hr/><a name="_details"></a><h2>Detailed Description</h2>
50
<p>the robot sensor matrix </p>
51
<p>These functions and structures are used for localization to determine the relative directions of robots. </p>
52
<hr/><h2>Function Documentation</h2>
53
<a class="anchor" id="ga09523e52546e7929288795e1e5f0f9a8"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_create" ref="ga09523e52546e7929288795e1e5f0f9a8" args="(void)" -->
54 241 bcoltin
<div class="memitem">
55
<div class="memproto">
56
      <table class="memname">
57 19 bcoltin
        <tr>
58 1425 cmar
          <td class="memname">void sensor_matrix_create </td>
59 241 bcoltin
          <td>(</td>
60
          <td class="paramtype">void&nbsp;</td>
61 1425 cmar
          <td class="paramname"></td>
62 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
63 1380 cmar
          <td></td>
64 19 bcoltin
        </tr>
65
      </table>
66 241 bcoltin
</div>
67
<div class="memdoc">
68 19 bcoltin
69 1425 cmar
<p>Create a sensor matrix. </p>
70
<p>Initializes the sensor matrix.</p>
71
<dl class="return"><dt><b>Returns:</b></dt><dd>the newly created sensor matrix </dd></dl>
72 241 bcoltin
73 1380 cmar
<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>
74
75
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p>
76
77 241 bcoltin
</div>
78 1425 cmar
</div>
79
<a class="anchor" id="gac668dfe28e56b5a314789d395eda3b27"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_in_ring" ref="gac668dfe28e56b5a314789d395eda3b27" args="(int robot)" -->
80 241 bcoltin
<div class="memitem">
81
<div class="memproto">
82
      <table class="memname">
83 19 bcoltin
        <tr>
84 1425 cmar
          <td class="memname">int sensor_matrix_get_in_ring </td>
85 241 bcoltin
          <td>(</td>
86 737 bcoltin
          <td class="paramtype">int&nbsp;</td>
87 1425 cmar
          <td class="paramname"> <em>robot</em></td>
88 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
89 1380 cmar
          <td></td>
90 19 bcoltin
        </tr>
91
      </table>
92 241 bcoltin
</div>
93
<div class="memdoc">
94 19 bcoltin
95 1425 cmar
<p>Get whether the robot is in the sensor ring. </p>
96
<p>Checks if the given robot is in the token ring.</p>
97
<dl><dt><b>Parameters:</b></dt><dd>
98 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
99
    <tr><td valign="top"></td><td valign="top"><em>robot</em>&nbsp;</td><td>the ID of the robot to check</td></tr>
100
  </table>
101 1425 cmar
  </dd>
102 19 bcoltin
</dl>
103 1425 cmar
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the robot is in the token ring, 0 otherwise </dd></dl>
104 241 bcoltin
105 1380 cmar
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00070">SensorMatrix::joined</a>.</p>
106
107
<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>
108
109 241 bcoltin
</div>
110 1425 cmar
</div>
111
<a class="anchor" id="ga3545800eec0adba2fc63604206b8fb24"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_joined" ref="ga3545800eec0adba2fc63604206b8fb24" args="(void)" -->
112 241 bcoltin
<div class="memitem">
113
<div class="memproto">
114
      <table class="memname">
115 19 bcoltin
        <tr>
116 1425 cmar
          <td class="memname">int sensor_matrix_get_joined </td>
117 241 bcoltin
          <td>(</td>
118 737 bcoltin
          <td class="paramtype">void&nbsp;</td>
119 1425 cmar
          <td class="paramname"></td>
120 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
121 1380 cmar
          <td></td>
122 19 bcoltin
        </tr>
123
      </table>
124 241 bcoltin
</div>
125
<div class="memdoc">
126 19 bcoltin
127 1425 cmar
<p>Get the number of robots which have joined the token ring. </p>
128
<p>Returns the number of robots which have joined the token ring.</p>
129
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl>
130 241 bcoltin
131 1380 cmar
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00065">SensorMatrix::numJoined</a>.</p>
132
133
<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>
134
135 241 bcoltin
</div>
136 1425 cmar
</div>
137
<a class="anchor" id="ga031d5a4d15603e57379aad22da36e300"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_reading" ref="ga031d5a4d15603e57379aad22da36e300" args="(int observer, int robot)" -->
138 241 bcoltin
<div class="memitem">
139
<div class="memproto">
140
      <table class="memname">
141 19 bcoltin
        <tr>
142 1425 cmar
          <td class="memname">int sensor_matrix_get_reading </td>
143 241 bcoltin
          <td>(</td>
144
          <td class="paramtype">int&nbsp;</td>
145
          <td class="paramname"> <em>observer</em>, </td>
146 19 bcoltin
        </tr>
147
        <tr>
148 241 bcoltin
          <td class="paramkey"></td>
149
          <td></td>
150
          <td class="paramtype">int&nbsp;</td>
151
          <td class="paramname"> <em>robot</em></td><td>&nbsp;</td>
152 19 bcoltin
        </tr>
153
        <tr>
154 241 bcoltin
          <td></td>
155
          <td>)</td>
156 1380 cmar
          <td></td><td></td><td></td>
157 19 bcoltin
        </tr>
158
      </table>
159 241 bcoltin
</div>
160
<div class="memdoc">
161 19 bcoltin
162 1425 cmar
<p>Get a reading in a sensor matrix. </p>
163
<p>Gets the sensor reading for a robot to another robot.</p>
164
<dl><dt><b>Parameters:</b></dt><dd>
165 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
166
    <tr><td valign="top"></td><td valign="top"><em>observer</em>&nbsp;</td><td>the robot whose reading we check </td></tr>
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>
168
  </table>
169 1425 cmar
  </dd>
170 19 bcoltin
</dl>
171 1425 cmar
<dl class="return"><dt><b>Returns:</b></dt><dd>the observer's BOM reading for robot </dd></dl>
172 241 bcoltin
173 1380 cmar
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>.</p>
174
175
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00347">wl_token_get_sensor_reading()</a>.</p>
176
177 241 bcoltin
</div>
178 1425 cmar
</div>
179
<a class="anchor" id="gaa22a0851d1886ca29fc32e0692502f2d"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_size" ref="gaa22a0851d1886ca29fc32e0692502f2d" args="(void)" -->
180 241 bcoltin
<div class="memitem">
181
<div class="memproto">
182
      <table class="memname">
183 19 bcoltin
        <tr>
184 1425 cmar
          <td class="memname">int sensor_matrix_get_size </td>
185 241 bcoltin
          <td>(</td>
186 737 bcoltin
          <td class="paramtype">void&nbsp;</td>
187 1425 cmar
          <td class="paramname"></td>
188 241 bcoltin
          <td>&nbsp;)&nbsp;</td>
189 1380 cmar
          <td></td>
190 19 bcoltin
        </tr>
191
      </table>
192 241 bcoltin
</div>
193
<div class="memdoc">
194 19 bcoltin
195 1425 cmar
<p>Get the maximum size of the sensor matrix. </p>
196
<p>Returns the maximum XBee id of a robot which can be stored in the sensor matrix.</p>
197
<dl class="return"><dt><b>Returns:</b></dt><dd>the maximum number of robots which can be stored </dd></dl>
198 241 bcoltin
199 1380 cmar
<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>
200
201 241 bcoltin
</div>
202 1425 cmar
</div>
203
<a class="anchor" id="gaea879c1d5f8a8a079066d8df005f3549"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_in_ring" ref="gaea879c1d5f8a8a079066d8df005f3549" args="(int robot, int in)" -->
204 241 bcoltin
<div class="memitem">
205
<div class="memproto">
206
      <table class="memname">
207 19 bcoltin
        <tr>
208 1425 cmar
          <td class="memname">void sensor_matrix_set_in_ring </td>
209 241 bcoltin
          <td>(</td>
210
          <td class="paramtype">int&nbsp;</td>
211
          <td class="paramname"> <em>robot</em>, </td>
212 19 bcoltin
        </tr>
213
        <tr>
214 241 bcoltin
          <td class="paramkey"></td>
215
          <td></td>
216
          <td class="paramtype">int&nbsp;</td>
217
          <td class="paramname"> <em>in</em></td><td>&nbsp;</td>
218 19 bcoltin
        </tr>
219
        <tr>
220 241 bcoltin
          <td></td>
221
          <td>)</td>
222 1380 cmar
          <td></td><td></td><td></td>
223 19 bcoltin
        </tr>
224
      </table>
225 241 bcoltin
</div>
226
<div class="memdoc">
227 19 bcoltin
228 1425 cmar
<p>Set whether the robot is in the token ring. </p>
229
<p>Sets whether or not the given robot is part of the token ring.</p>
230
<dl><dt><b>Parameters:</b></dt><dd>
231 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
232
    <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>
233
    <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>
234
  </table>
235 1425 cmar
  </dd>
236 19 bcoltin
</dl>
237 241 bcoltin
238 1380 cmar
<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>
239
240
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p>
241
242 241 bcoltin
</div>
243 1425 cmar
</div>
244
<a class="anchor" id="gaf251d97aeb23af9156c0527692819da7"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_reading" ref="gaf251d97aeb23af9156c0527692819da7" args="(int observer, int robot, int reading)" -->
245 241 bcoltin
<div class="memitem">
246
<div class="memproto">
247
      <table class="memname">
248 19 bcoltin
        <tr>
249 1425 cmar
          <td class="memname">void sensor_matrix_set_reading </td>
250 241 bcoltin
          <td>(</td>
251
          <td class="paramtype">int&nbsp;</td>
252
          <td class="paramname"> <em>observer</em>, </td>
253 19 bcoltin
        </tr>
254
        <tr>
255 241 bcoltin
          <td class="paramkey"></td>
256
          <td></td>
257
          <td class="paramtype">int&nbsp;</td>
258
          <td class="paramname"> <em>robot</em>, </td>
259 19 bcoltin
        </tr>
260
        <tr>
261 241 bcoltin
          <td class="paramkey"></td>
262
          <td></td>
263
          <td class="paramtype">int&nbsp;</td>
264
          <td class="paramname"> <em>reading</em></td><td>&nbsp;</td>
265 19 bcoltin
        </tr>
266
        <tr>
267 241 bcoltin
          <td></td>
268
          <td>)</td>
269 1380 cmar
          <td></td><td></td><td></td>
270 19 bcoltin
        </tr>
271
      </table>
272 241 bcoltin
</div>
273
<div class="memdoc">
274 19 bcoltin
275 1425 cmar
<p>Set a reading in a sensor matrix. </p>
276
<p>Sets the sensor reading for robot robot to reading.</p>
277
<dl><dt><b>Parameters:</b></dt><dd>
278 19 bcoltin
  <table border="0" cellspacing="2" cellpadding="0">
279
    <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>
280
    <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>
281
    <tr><td valign="top"></td><td valign="top"><em>reading</em>&nbsp;</td><td>the BOM reading from observer to robot </td></tr>
282
  </table>
283 1425 cmar
  </dd>
284 19 bcoltin
</dl>
285 241 bcoltin
286 1380 cmar
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>.</p>
287
288 241 bcoltin
</div>
289 1380 cmar
</div>
290 1425 cmar
</div>
291 1427 cmar
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by&nbsp;
292 19 bcoltin
<a href="http://www.doxygen.org/index.html">
293 1425 cmar
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
294 19 bcoltin
</body>
295
</html>