Project

General

Profile

Revision 1380

Added by Chris Mar over 14 years ago

fixed doxygen problems in wireless library, added new docs

View differences:

structSensorMatrix.html
1 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3 
<title>libwireless: SensorMatrix Struct Reference</title>
4 
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.3 -->
8 
<div class="tabs">
9 
  <ul>
10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 
    <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 
    <li><a href="files.html"><span>Files</span></a></li>
14 
  </ul>
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>
15 23 
</div>
16 
<div class="tabs">
17 
  <ul>
18 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
19 
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
20 
  </ul>
21 
</div>
24 
<div class="contents">
22 25 
<h1>SensorMatrix Struct Reference<br>
23 26 
<small>
24 
[<a class="el" href="group__sensormatrix.html">Sensor Matrix</a>,&nbsp;<a class="el" href="group__sensormatrix.html">Sensor Matrix</a>]</small>
25 
</h1><!-- doxytag: class="SensorMatrix" --><code>#include &lt;<a class="el" href="sensor__matrix_8h-source.html">sensor_matrix.h</a>&gt;</code>
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>
26 29 
<p>
27 30 
<table border="0" cellpadding="0" cellspacing="0">
28 31 
<tr><td></td></tr>
29 32 
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
30 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>
31 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
  
    

  		




  32
  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>


  		




  33
  38
  
    

  		




  34
  
  
    
<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>


  		




  35
  
  
    

  		




  36
  39
  
    
</table>


  		




  37
  40
  
    
<hr><a name="_details"></a><h2>Detailed Description</h2>


  		




  38
  41
  
    
A sensor matrix. <hr><h2>Field Documentation</h2>


  		




  39
  
  
    
<a class="anchor" name="888d68ace5ba04bfc741241718bc297c"></a><!-- doxytag: member="SensorMatrix::numJoined" ref="888d68ace5ba04bfc741241718bc297c" args="" -->


  		




  
  42
  
    
<a class="anchor" name="b2317919ee816e791633d4dc239f45af"></a><!-- doxytag: member="SensorMatrix::joined" ref="b2317919ee816e791633d4dc239f45af" args="[MAXIMUM_XBEE_ID]" -->


  		




  40
  43
  
    
<div class="memitem">


  		




  41
  44
  
    
<div class="memproto">


  		




  42
  45
  
    
      <table class="memname">


  		




  43
  46
  
    
        <tr>


  		




  44
  
  
    
          <td class="memname">int <a class="el" href="structSensorMatrix.html#888d68ace5ba04bfc741241718bc297c">SensorMatrix::numJoined</a>          </td>


  		




  
  47
  
    
          <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#b2317919ee816e791633d4dc239f45af">SensorMatrix::joined</a>[MAXIMUM_XBEE_ID]          </td>


  		




  45
  48
  
    
        </tr>


  		




  46
  49
  
    
      </table>


  		




  47
  50
  
    
</div>


  		




  48
  51
  
    
<div class="memdoc">


  		




  49
  52
  
    

  		




  50
  53
  
    
<p>


  		




  51
  
  
    
The number of robots in the token ring. 


  		




  
  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
  
    

  		




  52
  57
  
    
</div>


  		




  53
  58
  
    
</div><p>


  		




  54
  59
  
    
<a class="anchor" name="85a82252ddabc13c586cceb9b2819b62"></a><!-- doxytag: member="SensorMatrix::matrix" ref="85a82252ddabc13c586cceb9b2819b62" args="[MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID]" -->


  		




  ......




  64
  69
  
    

  		




  65
  70
  
    
<p>


  		




  66
  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
  
    

  		




  67
  74
  
    
</div>


  		




  68
  75
  
    
</div><p>


  		




  69
  
  
    
<a class="anchor" name="b2317919ee816e791633d4dc239f45af"></a><!-- doxytag: member="SensorMatrix::joined" ref="b2317919ee816e791633d4dc239f45af" args="[MAXIMUM_XBEE_ID]" -->


  		




  
  76
  
    
<a class="anchor" name="888d68ace5ba04bfc741241718bc297c"></a><!-- doxytag: member="SensorMatrix::numJoined" ref="888d68ace5ba04bfc741241718bc297c" args="" -->


  		




  70
  77
  
    
<div class="memitem">


  		




  71
  78
  
    
<div class="memproto">


  		




  72
  79
  
    
      <table class="memname">


  		




  73
  80
  
    
        <tr>


  		




  74
  
  
    
          <td class="memname">unsigned char <a class="el" href="structSensorMatrix.html#b2317919ee816e791633d4dc239f45af">SensorMatrix::joined</a>[MAXIMUM_XBEE_ID]          </td>


  		




  
  81
  
    
          <td class="memname">int <a class="el" href="structSensorMatrix.html#888d68ace5ba04bfc741241718bc297c">SensorMatrix::numJoined</a>          </td>


  		




  75
  82
  
    
        </tr>


  		




  76
  83
  
    
      </table>


  		




  77
  84
  
    
</div>


  		




  78
  85
  
    
<div class="memdoc">


  		




  79
  86
  
    

  		




  80
  87
  
    
<p>


  		




  81
  
  
    
The element representing a robot is true if that robot is in the token ring and false otherwise. 


  		




  
  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
  
    

  		




  82
  91
  
    
</div>


  		




  83
  92
  
    
</div><p>


  		




  84
  93
  
    
<hr>The documentation for this struct was generated from the following file:<ul>


  		




  85
  
  
    
<li><a class="el" href="sensor__matrix_8h-source.html">sensor_matrix.h</a></ul>


  		




  86
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;


  		




  
  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 Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;


  		




  87
  97
  
    
<a href="http://www.doxygen.org/index.html">


  		




  88
  
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>


  		




  
  98
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


  		




  89
  99
  
    
</body>


  		




  90
  100
  
    
</html>


  		












Also available in:  Unified diff