<!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.3.0 C++ API: i2c Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="contents">
<h1>i2c Class Reference</h1><!-- doxytag: class="i2c" -->
<p>abstract 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 <<a class="el" href="i2c_8h_source.html">i2c.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for i2c:</div>
<div class="dynsection">
<div class="center"><img src="classi2c__inherit__graph.png" border="0" usemap="#i2c_inherit__map" alt="Inheritance graph"/></div>
<map name="i2c_inherit__map" id="i2c_inherit__map">
<area shape="rect" id="node3" href="classi2c__bitbang.html" title="class for controlling i2c bus" alt="" coords="5,83,93,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classi2c-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c.html#a5052b59bf4913cbbf093f19260fe25bb">i2c</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c.html#afd966136eb0a535bc31b2ac2d2edc37d">~i2c</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c.html#a8900e88f60f3d8c7790f17f909bdbcfa">write</a> (int addr, const unsigned char *buf, int nbytes)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classi2c.html#ab8cf2942ef888184214a18a2499a326b">read</a> (int addr, unsigned char *buf, int max_bytes)=0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>abstract class for controlling <a class="el" href="classi2c.html" title="abstract class for controlling i2c bus">i2c</a> bus </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5052b59bf4913cbbf093f19260fe25bb"></a><!-- doxytag: member="i2c::i2c" ref="a5052b59bf4913cbbf093f19260fe25bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">i2c::i2c </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="afd966136eb0a535bc31b2ac2d2edc37d"></a><!-- doxytag: member="i2c::~i2c" ref="afd966136eb0a535bc31b2ac2d2edc37d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual i2c::~i2c </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab8cf2942ef888184214a18a2499a326b"></a><!-- doxytag: member="i2c::read" ref="ab8cf2942ef888184214a18a2499a326b" args="(int addr, unsigned char *buf, int max_bytes)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int i2c::read </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>max_bytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure 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>Implemented in <a class="el" href="classi2c__bitbang.html#aef0f57915960f3356707dd9a62496f36">i2c_bitbang</a>.</p>
</div>
</div>
<a class="anchor" id="a8900e88f60f3d8c7790f17f909bdbcfa"></a><!-- doxytag: member="i2c::write" ref="a8900e88f60f3d8c7790f17f909bdbcfa" args="(int addr, const unsigned char *buf, int nbytes)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> i2c::write </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nbytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true iff successful </dd></dl>
<p>Implemented in <a class="el" href="classi2c__bitbang.html#a36b313126b420123bceacb962cc871e5">i2c_bitbang</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="i2c_8h_source.html">i2c.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:53:00 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
