Project

General

Profile

Revision 1425

Added by Chris Mar about 10 years ago

updated wireless basic library code and docs

View differences:

group__sensormatrix.html
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
1
<!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"/>
3 5
<title>libwireless: Sensor Matrix</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
</head><body>
7
<!-- Generated by Doxygen 1.5.9 -->
6
<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 -->
8 11
<div class="navigation" id="top">
9 12
  <div class="tabs">
10 13
    <ul>
......
16 19
  </div>
17 20
</div>
18 21
<div class="contents">
19
<h1>Sensor Matrix</h1>the robot sensor matrix  
20
<a href="#_details">More...</a>
21
<p>
22
<h1>Sensor Matrix</h1>
23
<p>the robot sensor matrix  
24
<a href="#_details">More...</a></p>
22 25
<table border="0" cellpadding="0" cellspacing="0">
23
<tr><td></td></tr>
24
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
25
<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>
26

  
27
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
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
<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="" -->
29 30
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MAXIMUM_XBEE_ID</b>&nbsp;&nbsp;&nbsp;0x10</td></tr>
30

  
31
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g782ef5f54e97435c631329a5e536f680"></a><!-- doxytag: member="sensormatrix::READING_UNKNOWN" ref="g782ef5f54e97435c631329a5e536f680" args="" -->
31
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga782ef5f54e97435c631329a5e536f680"></a><!-- doxytag: member="sensormatrix::READING_UNKNOWN" ref="ga782ef5f54e97435c631329a5e536f680" args="" -->
32 32
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>READING_UNKNOWN</b>&nbsp;&nbsp;&nbsp;0xFF</td></tr>
33

  
34
<tr><td colspan="2"><br><h2>Functions</h2></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#g09523e52546e7929288795e1e5f0f9a8">sensor_matrix_create</a> (void)</td></tr>
36

  
37
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a sensor matrix.  <a href="#g09523e52546e7929288795e1e5f0f9a8"></a><br></td></tr>
38
<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>
39

  
40
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a reading in a sensor matrix.  <a href="#gf251d97aeb23af9156c0527692819da7"></a><br></td></tr>
41
<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>
42

  
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a reading in a sensor matrix.  <a href="#g031d5a4d15603e57379aad22da36e300"></a><br></td></tr>
44
<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>
45

  
46
<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>
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#gc668dfe28e56b5a314789d395eda3b27">sensor_matrix_get_in_ring</a> (int robot)</td></tr>
48

  
49
<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>
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#g3545800eec0adba2fc63604206b8fb24">sensor_matrix_get_joined</a> (void)</td></tr>
51

  
52
<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>
53
<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>
54

  
55
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum size of the sensor matrix.  <a href="#ga22a0851d1886ca29fc32e0692502f2d"></a><br></td></tr>
33
<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>
56 48
</table>
57
<hr><a name="_details"></a><h2>Detailed Description</h2>
58
the robot sensor matrix 
59
<p>
60
These functions and structures are used for localization to determine the relative directions of robots. <hr><h2>Function Documentation</h2>
61
<a class="anchor" name="g09523e52546e7929288795e1e5f0f9a8"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_create" ref="g09523e52546e7929288795e1e5f0f9a8" args="(void)" -->
49
<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)" -->
62 54
<div class="memitem">
63 55
<div class="memproto">
64 56
      <table class="memname">
65 57
        <tr>
66
          <td class="memname">void sensor_matrix_create           </td>
58
          <td class="memname">void sensor_matrix_create </td>
67 59
          <td>(</td>
68 60
          <td class="paramtype">void&nbsp;</td>
69
          <td class="paramname">          </td>
61
          <td class="paramname"></td>
70 62
          <td>&nbsp;)&nbsp;</td>
71 63
          <td></td>
72 64
        </tr>
......
74 66
</div>
75 67
<div class="memdoc">
76 68

  
77
<p>
78
Create a sensor matrix. 
79
<p>
80
Initializes the sensor matrix.<p>
81
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the newly created sensor matrix </dd></dl>
69
<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>
82 72

  
83 73
<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 74

  
85 75
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p>
86 76

  
87 77
</div>
88
</div><p>
89
<a class="anchor" name="gc668dfe28e56b5a314789d395eda3b27"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_in_ring" ref="gc668dfe28e56b5a314789d395eda3b27" args="(int robot)" -->
78
</div>
79
<a class="anchor" id="gac668dfe28e56b5a314789d395eda3b27"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_in_ring" ref="gac668dfe28e56b5a314789d395eda3b27" args="(int robot)" -->
90 80
<div class="memitem">
91 81
<div class="memproto">
92 82
      <table class="memname">
93 83
        <tr>
94
          <td class="memname">int sensor_matrix_get_in_ring           </td>
84
          <td class="memname">int sensor_matrix_get_in_ring </td>
95 85
          <td>(</td>
96 86
          <td class="paramtype">int&nbsp;</td>
97
          <td class="paramname"> <em>robot</em>          </td>
87
          <td class="paramname"> <em>robot</em></td>
98 88
          <td>&nbsp;)&nbsp;</td>
99 89
          <td></td>
100 90
        </tr>
......
102 92
</div>
103 93
<div class="memdoc">
104 94

  
105
<p>
106
Get whether the robot is in the sensor ring. 
107
<p>
108
Checks if the given robot is in the token ring.<p>
109
<dl compact><dt><b>Parameters:</b></dt><dd>
95
<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>
110 98
  <table border="0" cellspacing="2" cellpadding="0">
111 99
    <tr><td valign="top"></td><td valign="top"><em>robot</em>&nbsp;</td><td>the ID of the robot to check</td></tr>
112 100
  </table>
101
  </dd>
113 102
</dl>
114
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the robot is in the token ring, 0 otherwise </dd></dl>
103
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the robot is in the token ring, 0 otherwise </dd></dl>
115 104

  
116 105
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00070">SensorMatrix::joined</a>.</p>
117 106

  
118 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>
119 108

  
120 109
</div>
121
</div><p>
122
<a class="anchor" name="g3545800eec0adba2fc63604206b8fb24"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_joined" ref="g3545800eec0adba2fc63604206b8fb24" args="(void)" -->
110
</div>
111
<a class="anchor" id="ga3545800eec0adba2fc63604206b8fb24"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_joined" ref="ga3545800eec0adba2fc63604206b8fb24" args="(void)" -->
123 112
<div class="memitem">
124 113
<div class="memproto">
125 114
      <table class="memname">
126 115
        <tr>
127
          <td class="memname">int sensor_matrix_get_joined           </td>
116
          <td class="memname">int sensor_matrix_get_joined </td>
128 117
          <td>(</td>
129 118
          <td class="paramtype">void&nbsp;</td>
130
          <td class="paramname">          </td>
119
          <td class="paramname"></td>
131 120
          <td>&nbsp;)&nbsp;</td>
132 121
          <td></td>
133 122
        </tr>
......
135 124
</div>
136 125
<div class="memdoc">
137 126

  
138
<p>
139
Get the number of robots which have joined the token ring. 
140
<p>
141
Returns the number of robots which have joined the token ring.<p>
142
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl>
127
<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>
143 130

  
144 131
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00065">SensorMatrix::numJoined</a>.</p>
145 132

  
146 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>
147 134

  
148 135
</div>
149
</div><p>
150
<a class="anchor" name="g031d5a4d15603e57379aad22da36e300"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_reading" ref="g031d5a4d15603e57379aad22da36e300" args="(int observer, int robot)" -->
136
</div>
137
<a class="anchor" id="ga031d5a4d15603e57379aad22da36e300"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_reading" ref="ga031d5a4d15603e57379aad22da36e300" args="(int observer, int robot)" -->
151 138
<div class="memitem">
152 139
<div class="memproto">
153 140
      <table class="memname">
154 141
        <tr>
155
          <td class="memname">int sensor_matrix_get_reading           </td>
142
          <td class="memname">int sensor_matrix_get_reading </td>
156 143
          <td>(</td>
157 144
          <td class="paramtype">int&nbsp;</td>
158 145
          <td class="paramname"> <em>observer</em>, </td>
......
172 159
</div>
173 160
<div class="memdoc">
174 161

  
175
<p>
176
Get a reading in a sensor matrix. 
177
<p>
178
Gets the sensor reading for a robot to another robot.<p>
179
<dl compact><dt><b>Parameters:</b></dt><dd>
162
<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>
180 165
  <table border="0" cellspacing="2" cellpadding="0">
181 166
    <tr><td valign="top"></td><td valign="top"><em>observer</em>&nbsp;</td><td>the robot whose reading we check </td></tr>
182 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>
183 168
  </table>
169
  </dd>
184 170
</dl>
185
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the observer's BOM reading for robot </dd></dl>
171
<dl class="return"><dt><b>Returns:</b></dt><dd>the observer's BOM reading for robot </dd></dl>
186 172

  
187 173
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>.</p>
188 174

  
189 175
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00347">wl_token_get_sensor_reading()</a>.</p>
190 176

  
191 177
</div>
192
</div><p>
193
<a class="anchor" name="ga22a0851d1886ca29fc32e0692502f2d"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_size" ref="ga22a0851d1886ca29fc32e0692502f2d" args="(void)" -->
178
</div>
179
<a class="anchor" id="gaa22a0851d1886ca29fc32e0692502f2d"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_get_size" ref="gaa22a0851d1886ca29fc32e0692502f2d" args="(void)" -->
194 180
<div class="memitem">
195 181
<div class="memproto">
196 182
      <table class="memname">
197 183
        <tr>
198
          <td class="memname">int sensor_matrix_get_size           </td>
184
          <td class="memname">int sensor_matrix_get_size </td>
199 185
          <td>(</td>
200 186
          <td class="paramtype">void&nbsp;</td>
201
          <td class="paramname">          </td>
187
          <td class="paramname"></td>
202 188
          <td>&nbsp;)&nbsp;</td>
203 189
          <td></td>
204 190
        </tr>
......
206 192
</div>
207 193
<div class="memdoc">
208 194

  
209
<p>
210
Get the maximum size of the sensor matrix. 
211
<p>
212
Returns the maximum XBee id of a robot which can be stored in the sensor matrix.<p>
213
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the maximum number of robots which can be stored </dd></dl>
195
<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>
214 198

  
215 199
<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 200

  
217 201
</div>
218
</div><p>
219
<a class="anchor" name="gea879c1d5f8a8a079066d8df005f3549"></a><!-- doxytag: member="sensor_matrix.h::sensor_matrix_set_in_ring" ref="gea879c1d5f8a8a079066d8df005f3549" args="(int robot, int in)" -->
202
</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)" -->
220 204
<div class="memitem">
221 205
<div class="memproto">
222 206
      <table class="memname">
223 207
        <tr>
224
          <td class="memname">void sensor_matrix_set_in_ring           </td>
208
          <td class="memname">void sensor_matrix_set_in_ring </td>
225 209
          <td>(</td>
226 210
          <td class="paramtype">int&nbsp;</td>
227 211
          <td class="paramname"> <em>robot</em>, </td>
......
241 225
</div>
242 226
<div class="memdoc">
243 227

  
244
<p>
245
Set whether the robot is in the token ring. 
246
<p>
247
Sets whether or not the given robot is part of the token ring.<p>
248
<dl compact><dt><b>Parameters:</b></dt><dd>
228
<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>
249 231
  <table border="0" cellspacing="2" cellpadding="0">
250 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>
251 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>
252 234
  </table>
235
  </dd>
253 236
</dl>
254 237

  
255 238
<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>
......
257 240
<p>Referenced by <a class="el" href="wl__token__ring_8c_source.html#l00170">wl_token_ring_register()</a>.</p>
258 241

  
259 242
</div>
260
</div><p>
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)" -->
243
</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)" -->
262 245
<div class="memitem">
263 246
<div class="memproto">
264 247
      <table class="memname">
265 248
        <tr>
266
          <td class="memname">void sensor_matrix_set_reading           </td>
249
          <td class="memname">void sensor_matrix_set_reading </td>
267 250
          <td>(</td>
268 251
          <td class="paramtype">int&nbsp;</td>
269 252
          <td class="paramname"> <em>observer</em>, </td>
......
289 272
</div>
290 273
<div class="memdoc">
291 274

  
292
<p>
293
Set a reading in a sensor matrix. 
294
<p>
295
Sets the sensor reading for robot robot to reading.<p>
296
<dl compact><dt><b>Parameters:</b></dt><dd>
275
<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>
297 278
  <table border="0" cellspacing="2" cellpadding="0">
298 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>
299 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>
300 281
    <tr><td valign="top"></td><td valign="top"><em>reading</em>&nbsp;</td><td>the BOM reading from observer to robot </td></tr>
301 282
  </table>
283
  </dd>
302 284
</dl>
303 285

  
304 286
<p>References <a class="el" href="sensor__matrix_8h_source.html#l00078">SensorMatrix::matrix</a>.</p>
305 287

  
306 288
</div>
307
</div><p>
308 289
</div>
309
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by&nbsp;
290
</div>
291
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by&nbsp;
310 292
<a href="http://www.doxygen.org/index.html">
311
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
293
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
312 294
</body>
313 295
</html>

Also available in: Unified diff