Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / sensor__matrix_8h_source.html @ 1427

History | View | Annotate | Download (6.01 KB)

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"/>
5 
<title>libwireless: sensor_matrix.h Source File</title>
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 -->
11 
<div class="navigation" id="top">
12 
  <div class="tabs">
13 
    <ul>
14 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15 
      <li><a href="modules.html"><span>Modules</span></a></li>
16 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
18 
    </ul>
19 
  </div>
20 
  <div class="tabs">
21 
    <ul>
22 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
23 
      <li><a href="globals.html"><span>Globals</span></a></li>
24 
    </ul>
25 
  </div>
26 
<h1>sensor_matrix.h</h1><a href="sensor__matrix_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
27 
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef SENSOR_MATRIX_H</span>
28 
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define SENSOR_MATRIX_H</span>
29 
<a name="l00037"></a>00037 <span class="preprocessor"></span>
30 
<a name="l00038"></a>00038
31 
<a name="l00049"></a>00049 <span class="preprocessor">#define MAXIMUM_XBEE_ID         0x10</span>
32 
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#define READING_UNKNOWN         0xFF</span>
33 
<a name="l00051"></a>00051 <span class="preprocessor"></span>
34 
<a name="l00057"></a>00057 <span class="comment">//TODO: the order of member variables in this struct should be changed in case the compile packs the struct</span>
35 
<a name="l00058"></a>00058 <span class="comment">// In order to achieve the best packing, the variables should be listed in order of decreasing memory size.</span>
36 
<a name="l00059"></a>00059 <span class="comment">// Thus, pointers should be first, followed by int, followed by char.</span>
37 
<a name="l00060"></a><a class="code" href="structSensorMatrix.html">00060</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
38 
<a name="l00061"></a>00061 {
39 
<a name="l00065"></a><a class="code" href="structSensorMatrix.html#a888d68ace5ba04bfc741241718bc297c">00065</a>         <span class="keywordtype">int</span> numJoined;
40 
<a name="l00070"></a><a class="code" href="structSensorMatrix.html#ab2317919ee816e791633d4dc239f45af">00070</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> joined[MAXIMUM_XBEE_ID];
41 
<a name="l00071"></a>00071
42 
<a name="l00072"></a>00072         <span class="comment">// on the bayboard, we don&apos;t include the matrix to save memory.</span>
43 
<a name="l00073"></a>00073 <span class="preprocessor">#ifndef BAYBOARD</span>
44 
<a name="l00074"></a>00074 <span class="preprocessor"></span>
45 
<a name="l00078"></a><a class="code" href="structSensorMatrix.html#a85a82252ddabc13c586cceb9b2819b62">00078</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> matrix[MAXIMUM_XBEE_ID][MAXIMUM_XBEE_ID];
46 
<a name="l00079"></a>00079 <span class="preprocessor">#endif</span>
47 
<a name="l00080"></a>00080 <span class="preprocessor"></span>} <a class="code" href="structSensorMatrix.html">SensorMatrix</a>;
48 
<a name="l00081"></a>00081
49 
<a name="l00083"></a>00083 <span class="keywordtype">void</span> <a class="code" href="group__sensormatrix.html#ga09523e52546e7929288795e1e5f0f9a8" title="Create a sensor matrix.">sensor_matrix_create</a>(<span class="keywordtype">void</span>);
50 
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="group__sensormatrix.html#gaf251d97aeb23af9156c0527692819da7" title="Set a reading in a sensor matrix.">sensor_matrix_set_reading</a>(<span class="keywordtype">int</span> observer, <span class="keywordtype">int</span> robot, <span class="keywordtype">int</span> reading);
51 
<a name="l00087"></a>00087 <span class="keywordtype">int</span> <a class="code" href="group__sensormatrix.html#ga031d5a4d15603e57379aad22da36e300" title="Get a reading in a sensor matrix.">sensor_matrix_get_reading</a>(<span class="keywordtype">int</span> observer, <span class="keywordtype">int</span> robot);
52 
<a name="l00089"></a>00089 <span class="keywordtype">void</span> <a class="code" href="group__sensormatrix.html#gaea879c1d5f8a8a079066d8df005f3549" title="Set whether the robot is in the token ring.">sensor_matrix_set_in_ring</a>(<span class="keywordtype">int</span> robot, <span class="keywordtype">int</span> in);
53 
<a name="l00091"></a>00091 <span class="keywordtype">int</span> <a class="code" href="group__sensormatrix.html#gac668dfe28e56b5a314789d395eda3b27" title="Get whether the robot is in the sensor ring.">sensor_matrix_get_in_ring</a>(<span class="keywordtype">int</span> robot);
54 
<a name="l00093"></a>00093 <span class="keywordtype">int</span> <a class="code" href="group__sensormatrix.html#ga3545800eec0adba2fc63604206b8fb24" title="Get the number of robots which have joined the token ring.">sensor_matrix_get_joined</a>(<span class="keywordtype">void</span>);
55 
<a name="l00095"></a>00095 <span class="keywordtype">int</span> <a class="code" href="group__sensormatrix.html#gaa22a0851d1886ca29fc32e0692502f2d" title="Get the maximum size of the sensor matrix.">sensor_matrix_get_size</a>(<span class="keywordtype">void</span>);
56 
<a name="l00096"></a>00096  <span class="comment">//end defgroup</span>
57 
<a name="l00098"></a>00098
58 
<a name="l00099"></a>00099
59 
<a name="l00100"></a>00100 <span class="preprocessor">#endif</span>
60 
<a name="l00101"></a>00101 <span class="preprocessor"></span>
61 
</pre></div></div>
62 
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by&nbsp;
63 
<a href="http://www.doxygen.org/index.html">
64 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
65 
</body>
66 
</html>