Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 2371

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.2.2 C++ API: i2c_bitbang Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">GNU Radio 3.2.2 C++ API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classi2c__bitbang.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<h1>i2c_bitbang Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="i2c_bitbang" --><!-- doxytag: inherits="i2c" -->
<p>class for controlling <a class="el" href="classi2c.html" title="abstract class for controlling i2c bus">i2c</a> bus  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="i2c__bitbang_8h_source.html">i2c_bitbang.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for i2c_bitbang:</div>
<div class="dyncontent">
<div class="center"><img src="classi2c__bitbang__inherit__graph.png" border="0" usemap="#i2c__bitbang_inherit__map" alt="Inheritance graph"/></div>
<map name="i2c__bitbang_inherit__map" id="i2c__bitbang_inherit__map">
<area shape="rect" id="node2" href="classi2c.html" title="abstract class for controlling i2c bus" alt="" coords="31,5,68,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classi2c__bitbang-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__bitbang.html#aadb3fd0bbe3d812470edfa26cb8da773">~i2c_bitbang</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__bitbang.html#a36b313126b420123bceacb962cc871e5">write</a> (int addr, const unsigned char *buf, int nbytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__bitbang.html#aef0f57915960f3356707dd9a62496f36">read</a> (int addr, unsigned char *buf, int max_bytes)</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">i2c_sptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c__bitbang.html#a2c1399f8888b727e1dff4ccf22d07628">make_i2c_bitbang</a> (<a class="el" href="classboost_1_1shared__ptr.html">i2c_bbio_sptr</a> io)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>class for controlling <a class="el" href="classi2c.html" title="abstract class for controlling i2c bus">i2c</a> bus </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aadb3fd0bbe3d812470edfa26cb8da773"></a><!-- doxytag: member="i2c_bitbang::~i2c_bitbang" ref="aadb3fd0bbe3d812470edfa26cb8da773" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">i2c_bitbang::~i2c_bitbang </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aef0f57915960f3356707dd9a62496f36"></a><!-- doxytag: member="i2c_bitbang::read" ref="aef0f57915960f3356707dd9a62496f36" args="(int addr, unsigned char *buf, int max_bytes)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int i2c_bitbang::read </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>max_bytes</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes read or -1 if error </dd></dl>

<p>Implements <a class="el" href="classi2c.html#ab8cf2942ef888184214a18a2499a326b">i2c</a>.</p>

</div>
</div>
<a class="anchor" id="a36b313126b420123bceacb962cc871e5"></a><!-- doxytag: member="i2c_bitbang::write" ref="a36b313126b420123bceacb962cc871e5" args="(int addr, const unsigned char *buf, int nbytes)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> i2c_bitbang::write </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>nbytes</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true iff successful </dd></dl>

<p>Implements <a class="el" href="classi2c.html#a8900e88f60f3d8c7790f17f909bdbcfa">i2c</a>.</p>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a2c1399f8888b727e1dff4ccf22d07628"></a><!-- doxytag: member="i2c_bitbang::make_i2c_bitbang" ref="a2c1399f8888b727e1dff4ccf22d07628" args="(i2c_bbio_sptr io)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">i2c_sptr</a> make_i2c_bitbang </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">i2c_bbio_sptr</a>&#160;</td>
          <td class="paramname"><em>io</em></td><td>)</td>
          <td><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="i2c__bitbang_8h_source.html">i2c_bitbang.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classi2c__bitbang.html">i2c_bitbang</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>