Project

General

Profile

Revision 1425

Added by Chris Mar over 14 years ago

updated wireless basic library code and docs

View differences:

structSensorMatrix.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: SensorMatrix Struct Reference</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>
......
22 25
  </div>
23 26
</div>
24 27
<div class="contents">
25
<h1>SensorMatrix Struct Reference<br>
28
<h1>SensorMatrix Struct Reference<br/>
26 29
<small>
27 30
[<a class="el" href="group__sensormatrix.html">Sensor Matrix</a>]</small>
28
</h1><!-- doxytag: class="SensorMatrix" --><code>#include &lt;<a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a>&gt;</code>
29
<p>
31
</h1><!-- doxytag: class="SensorMatrix" -->
32
<p><code>#include &lt;<a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a>&gt;</code></p>
30 33
<table border="0" cellpadding="0" cellspacing="0">
31
<tr><td></td></tr>
32
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
33
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html#888d68ace5ba04bfc741241718bc297c">numJoined</a></td></tr>
34

  
35
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html#b2317919ee816e791633d4dc239f45af">joined</a> [MAXIMUM_XBEE_ID]</td></tr>
36

  
37
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html#85a82252ddabc13c586cceb9b2819b62">matrix</a> [MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]</td></tr>
38

  
34
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
35
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</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&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSensorMatrix.html#a85a82252ddabc13c586cceb9b2819b62">matrix</a> [MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]</td></tr>
39 38
</table>
40
<hr><a name="_details"></a><h2>Detailed Description</h2>
41
A sensor matrix. <hr><h2>Field Documentation</h2>
42
<a class="anchor" name="b2317919ee816e791633d4dc239f45af"></a><!-- doxytag: member="SensorMatrix::joined" ref="b2317919ee816e791633d4dc239f45af" args="[MAXIMUM_XBEE_ID]" -->
39
<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 43
<div class="memitem">
44 44
<div class="memproto">
45 45
      <table class="memname">
46 46
        <tr>
47
          <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#b2317919ee816e791633d4dc239f45af">SensorMatrix::joined</a>[MAXIMUM_XBEE_ID]          </td>
47
          <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#ab2317919ee816e791633d4dc239f45af">SensorMatrix::joined</a>[MAXIMUM_XBEE_ID]</td>
48 48
        </tr>
49 49
      </table>
50 50
</div>
51 51
<div class="memdoc">
52
<p>The element representing a robot is true if that robot is in the token ring and false otherwise. </p>
52 53

  
53
<p>
54
The element representing a robot is true if that robot is in the token ring and false otherwise. 
55 54
<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>
56 55

  
57 56
</div>
58
</div><p>
59
<a class="anchor" name="85a82252ddabc13c586cceb9b2819b62"></a><!-- doxytag: member="SensorMatrix::matrix" ref="85a82252ddabc13c586cceb9b2819b62" args="[MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]" -->
57
</div>
58
<a class="anchor" id="a85a82252ddabc13c586cceb9b2819b62"></a><!-- doxytag: member="SensorMatrix::matrix" ref="a85a82252ddabc13c586cceb9b2819b62" args="[MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]" -->
60 59
<div class="memitem">
61 60
<div class="memproto">
62 61
      <table class="memname">
63 62
        <tr>
64
          <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#85a82252ddabc13c586cceb9b2819b62">SensorMatrix::matrix</a>[MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]          </td>
63
          <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#a85a82252ddabc13c586cceb9b2819b62">SensorMatrix::matrix</a>[MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]</td>
65 64
        </tr>
66 65
      </table>
67 66
</div>
68 67
<div class="memdoc">
68
<p>The matrix. Each row represents the readings of one robot. </p>
69 69

  
70
<p>
71
The matrix. Each row represents the readings of one robot. 
72 70
<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>
73 71

  
74 72
</div>
75
</div><p>
76
<a class="anchor" name="888d68ace5ba04bfc741241718bc297c"></a><!-- doxytag: member="SensorMatrix::numJoined" ref="888d68ace5ba04bfc741241718bc297c" args="" -->
73
</div>
74
<a class="anchor" id="a888d68ace5ba04bfc741241718bc297c"></a><!-- doxytag: member="SensorMatrix::numJoined" ref="a888d68ace5ba04bfc741241718bc297c" args="" -->
77 75
<div class="memitem">
78 76
<div class="memproto">
79 77
      <table class="memname">
80 78
        <tr>
81
          <td class="memname">int <a class="el" href="structSensorMatrix.html#888d68ace5ba04bfc741241718bc297c">SensorMatrix::numJoined</a>          </td>
79
          <td class="memname">int <a class="el" href="structSensorMatrix.html#a888d68ace5ba04bfc741241718bc297c">SensorMatrix::numJoined</a></td>
82 80
        </tr>
83 81
      </table>
84 82
</div>
85 83
<div class="memdoc">
84
<p>The number of robots in the token ring. </p>
86 85

  
87
<p>
88
The number of robots in the token ring. 
89 86
<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>
90 87

  
91 88
</div>
92
</div><p>
93
<hr>The documentation for this struct was generated from the following file:<ul>
94
<li><a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a></ul>
95 89
</div>
96
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by&nbsp;
90
<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
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by&nbsp;
97 95
<a href="http://www.doxygen.org/index.html">
98
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
96
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
99 97
</body>
100 98
</html>

Also available in: Unified diff