Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / structSensorMatrix.html @ 1395

History | View | Annotate | Download (5.15 KB)

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">
3
<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 -->
8
<div class="navigation" id="top">
9
  <div class="tabs">
10
    <ul>
11
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12
      <li><a href="modules.html"><span>Modules</span></a></li>
13
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
14
      <li><a href="files.html"><span>Files</span></a></li>
15
    </ul>
16
  </div>
17
  <div class="tabs">
18
    <ul>
19
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
20
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
21
    </ul>
22
  </div>
23
</div>
24
<div class="contents">
25
<h1>SensorMatrix Struct Reference<br>
26
<small>
27
[<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>
30
<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

    
39
</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]" -->
43
<div class="memitem">
44
<div class="memproto">
45
      <table class="memname">
46
        <tr>
47
          <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#b2317919ee816e791633d4dc239f45af">SensorMatrix::joined</a>[MAXIMUM_XBEE_ID]          </td>
48
        </tr>
49
      </table>
50
</div>
51
<div class="memdoc">
52

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

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

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

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

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

    
91
</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
</div>
96
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by&nbsp;
97
<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>
99
</body>
100
</html>