root / trunk / docs / libwireless / structSensorMatrix.html @ 1844
History | View | Annotate | Download (5.2 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: SensorMatrix Struct Reference</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 Page</span></a></li> |
||
15 | <li><a href="modules.html"><span>Modules</span></a></li> |
||
16 | <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
||
17 | <li><a href="files.html"><span>Files</span></a></li> |
||
18 | </ul>
|
||
19 | </div>
|
||
20 | <div class="tabs"> |
||
21 | <ul>
|
||
22 | <li><a href="annotated.html"><span>Data Structures</span></a></li> |
||
23 | <li><a href="functions.html"><span>Data Fields</span></a></li> |
||
24 | </ul>
|
||
25 | </div>
|
||
26 | 241 | bcoltin | </div>
|
27 | 1380 | cmar | <div class="contents"> |
28 | 1425 | cmar | <h1>SensorMatrix Struct Reference<br/> |
29 | 19 | bcoltin | <small>
|
30 | 1380 | cmar | [<a class="el" href="group__sensormatrix.html">Sensor Matrix</a>]</small> |
31 | 1425 | cmar | </h1><!-- doxytag: class="SensorMatrix" --> |
32 | <p><code>#include <<a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a>></code></p> |
||
33 | 19 | bcoltin | <table border="0" cellpadding="0" cellspacing="0"> |
34 | 1425 | cmar | <tr><td colspan="2"><h2>Data Fields</h2></td></tr> |
35 | <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html#a888d68ace5ba04bfc741241718bc297c">numJoined</a></td></tr> |
||
36 | <tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html#ab2317919ee816e791633d4dc239f45af">joined</a> [MAXIMUM_XBEE_ID]</td></tr> |
||
37 | <tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html#a85a82252ddabc13c586cceb9b2819b62">matrix</a> [MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]</td></tr> |
||
38 | 19 | bcoltin | </table>
|
39 | 1425 | cmar | <hr/><a name="_details"></a><h2>Detailed Description</h2> |
40 | <p>A sensor matrix. </p> |
||
41 | <hr/><h2>Field Documentation</h2> |
||
42 | <a class="anchor" id="ab2317919ee816e791633d4dc239f45af"></a><!-- doxytag: member="SensorMatrix::joined" ref="ab2317919ee816e791633d4dc239f45af" args="[MAXIMUM_XBEE_ID]" --> |
||
43 | 241 | bcoltin | <div class="memitem"> |
44 | <div class="memproto"> |
||
45 | <table class="memname"> |
||
46 | 19 | bcoltin | <tr>
|
47 | 1425 | cmar | <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#ab2317919ee816e791633d4dc239f45af">SensorMatrix::joined</a>[MAXIMUM_XBEE_ID]</td> |
48 | 19 | bcoltin | </tr>
|
49 | </table>
|
||
50 | 241 | bcoltin | </div>
|
51 | <div class="memdoc"> |
||
52 | 1425 | cmar | <p>The element representing a robot is true if that robot is in the token ring and false otherwise. </p> |
53 | 19 | bcoltin | |
54 | 1380 | cmar | <p>Referenced by <a class="el" href="sensor__matrix_8c_source.html#l00049">sensor_matrix_create()</a>, <a class="el" href="sensor__matrix_8c_source.html#l00134">sensor_matrix_get_in_ring()</a>, and <a class="el" href="sensor__matrix_8c_source.html#l00111">sensor_matrix_set_in_ring()</a>.</p> |
55 | |||
56 | 241 | bcoltin | </div>
|
57 | 1425 | cmar | </div>
|
58 | <a class="anchor" id="a85a82252ddabc13c586cceb9b2819b62"></a><!-- doxytag: member="SensorMatrix::matrix" ref="a85a82252ddabc13c586cceb9b2819b62" args="[MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]" --> |
||
59 | 241 | bcoltin | <div class="memitem"> |
60 | <div class="memproto"> |
||
61 | <table class="memname"> |
||
62 | 19 | bcoltin | <tr>
|
63 | 1425 | cmar | <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#a85a82252ddabc13c586cceb9b2819b62">SensorMatrix::matrix</a>[MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]</td> |
64 | 19 | bcoltin | </tr>
|
65 | </table>
|
||
66 | 241 | bcoltin | </div>
|
67 | <div class="memdoc"> |
||
68 | 1425 | cmar | <p>The matrix. Each row represents the readings of one robot. </p> |
69 | 19 | bcoltin | |
70 | 1380 | cmar | <p>Referenced by <a class="el" href="sensor__matrix_8c_source.html#l00049">sensor_matrix_create()</a>, <a class="el" href="sensor__matrix_8c_source.html#l00093">sensor_matrix_get_reading()</a>, and <a class="el" href="sensor__matrix_8c_source.html#l00072">sensor_matrix_set_reading()</a>.</p> |
71 | |||
72 | 241 | bcoltin | </div>
|
73 | 1425 | cmar | </div>
|
74 | <a class="anchor" id="a888d68ace5ba04bfc741241718bc297c"></a><!-- doxytag: member="SensorMatrix::numJoined" ref="a888d68ace5ba04bfc741241718bc297c" args="" --> |
||
75 | 241 | bcoltin | <div class="memitem"> |
76 | <div class="memproto"> |
||
77 | <table class="memname"> |
||
78 | 19 | bcoltin | <tr>
|
79 | 1425 | cmar | <td class="memname">int <a class="el" href="structSensorMatrix.html#a888d68ace5ba04bfc741241718bc297c">SensorMatrix::numJoined</a></td> |
80 | 19 | bcoltin | </tr>
|
81 | </table>
|
||
82 | 241 | bcoltin | </div>
|
83 | <div class="memdoc"> |
||
84 | 1425 | cmar | <p>The number of robots in the token ring. </p> |
85 | 19 | bcoltin | |
86 | 1380 | cmar | <p>Referenced by <a class="el" href="sensor__matrix_8c_source.html#l00049">sensor_matrix_create()</a>, <a class="el" href="sensor__matrix_8c_source.html#l00148">sensor_matrix_get_joined()</a>, and <a class="el" href="sensor__matrix_8c_source.html#l00111">sensor_matrix_set_in_ring()</a>.</p> |
87 | |||
88 | 241 | bcoltin | </div>
|
89 | 1380 | cmar | </div>
|
90 | 1425 | cmar | <hr/>The documentation for this struct was generated from the following file:<ul> |
91 | <li><a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a></li> |
||
92 | </ul>
|
||
93 | </div>
|
||
94 | 1427 | cmar | <hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by |
95 | 19 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
96 | 1425 | cmar | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
97 | 19 | bcoltin | </body>
|
98 | </html> |