Sophie

Sophie

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

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: fusb_generic.h Source File</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('fusb__generic_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>fusb_generic.h</h1>  </div>
</div>
<div class="contents">
<a href="fusb__generic_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2003 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef _FUSB_GENERIC_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define _FUSB_GENERIC_H_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="fusb_8h.html">fusb.h</a>&gt;</span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/*!</span>
<a name="l00029"></a>00029 <span class="comment"> * \brief generic implementation of fusb_devhandle using only libusb</span>
<a name="l00030"></a>00030 <span class="comment"> */</span>
<a name="l00031"></a><a class="code" href="classfusb__devhandle__generic.html">00031</a> <span class="keyword">class </span><a class="code" href="classfusb__devhandle__generic.html" title="generic implementation of fusb_devhandle using only libusb">fusb_devhandle_generic</a> : <span class="keyword">public</span> <a class="code" href="classfusb__devhandle.html" title="abstract usb device handle">fusb_devhandle</a>
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="keyword">public</span>:
<a name="l00034"></a>00034   <span class="comment">// CREATORS</span>
<a name="l00035"></a>00035   <a class="code" href="classfusb__devhandle__generic.html#ac0f4e12cd9454cf3afb4bf0c45f4c68e">fusb_devhandle_generic</a> (<a class="code" href="structusb__dev__handle.html">usb_dev_handle</a> *udh);
<a name="l00036"></a>00036   <span class="keyword">virtual</span> <a class="code" href="classfusb__devhandle__generic.html#a570890d17c2efdec4428b7a320ed5bc8">~fusb_devhandle_generic</a> ();
<a name="l00037"></a>00037 
<a name="l00038"></a>00038   <span class="comment">// MANIPULATORS</span>
<a name="l00039"></a>00039   <span class="keyword">virtual</span> <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a> *<a class="code" href="classfusb__devhandle__generic.html#a217d16f9e67b0850086371ba11c369bc" title="return an ephandle of the correct subtype">make_ephandle</a> (<span class="keywordtype">int</span> endpoint, <span class="keywordtype">bool</span> input_p,
<a name="l00040"></a>00040                                         <span class="keywordtype">int</span> block_size = 0, <span class="keywordtype">int</span> nblocks = 0);
<a name="l00041"></a>00041 };
<a name="l00042"></a>00042 
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">/*!</span>
<a name="l00045"></a>00045 <span class="comment"> * \brief generic implementation of fusb_ephandle using only libusb</span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a><a class="code" href="classfusb__ephandle__generic.html">00047</a> <span class="keyword">class </span><a class="code" href="classfusb__ephandle__generic.html" title="generic implementation of fusb_ephandle using only libusb">fusb_ephandle_generic</a> : <span class="keyword">public</span> <a class="code" href="classfusb__ephandle.html" title="abstract usb end point handle">fusb_ephandle</a>
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">private</span>:
<a name="l00050"></a>00050   <a class="code" href="classfusb__devhandle__generic.html" title="generic implementation of fusb_devhandle using only libusb">fusb_devhandle_generic</a>        *d_devhandle;
<a name="l00051"></a>00051   
<a name="l00052"></a>00052 <span class="keyword">public</span>:
<a name="l00053"></a>00053   <span class="comment">// CREATORS</span>
<a name="l00054"></a>00054   <a class="code" href="classfusb__ephandle__generic.html#a830f0afd5a768fef69afaf68c26791f3">fusb_ephandle_generic</a> (<a class="code" href="classfusb__devhandle__generic.html" title="generic implementation of fusb_devhandle using only libusb">fusb_devhandle_generic</a> *dh, <span class="keywordtype">int</span> endpoint, <span class="keywordtype">bool</span> input_p,
<a name="l00055"></a>00055                          <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle.html#a969c00b4d8ef3c8ad6444eb92da7a61c" title="returns current block size.">block_size</a> = 0, <span class="keywordtype">int</span> nblocks = 0);
<a name="l00056"></a>00056   <span class="keyword">virtual</span> <a class="code" href="classfusb__ephandle__generic.html#a46e53a8ce5446542ec27ecf8b8009e3c">~fusb_ephandle_generic</a> ();
<a name="l00057"></a>00057 
<a name="l00058"></a>00058   <span class="comment">// MANIPULATORS</span>
<a name="l00059"></a>00059 
<a name="l00060"></a>00060   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classfusb__ephandle__generic.html#a9fc2262b4072a85a835942723b8f39c6" title="begin streaming i/o">start</a> ();        <span class="comment">//!&lt; begin streaming i/o</span>
<a name="l00061"></a>00061 <span class="comment"></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classfusb__ephandle__generic.html#aa563a49a03165b2b23a1b9f8529db942" title="stop streaming i/o">stop</a> ();         <span class="comment">//!&lt; stop streaming i/o</span>
<a name="l00062"></a>00062 <span class="comment"></span><span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment">  /*!</span>
<a name="l00064"></a>00064 <span class="comment">   * \returns \p nbytes if write was successfully enqueued, else -1.</span>
<a name="l00065"></a>00065 <span class="comment">   * Will block if no free buffers available.</span>
<a name="l00066"></a>00066 <span class="comment">   */</span>
<a name="l00067"></a>00067   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle__generic.html#a2af659b1b0c8a74a59e9059878a1e496">write</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *buffer, <span class="keywordtype">int</span> nbytes);
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment">  /*!</span>
<a name="l00070"></a>00070 <span class="comment">   * \returns number of bytes read or -1 if error.</span>
<a name="l00071"></a>00071 <span class="comment">   * number of bytes read will be &lt;= nbytes.</span>
<a name="l00072"></a>00072 <span class="comment">   * Will block if no input available.</span>
<a name="l00073"></a>00073 <span class="comment">   */</span>
<a name="l00074"></a>00074   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classfusb__ephandle__generic.html#a893ea1a1d60ba9f0a41b6a1bba31edaf">read</a> (<span class="keywordtype">void</span> *buffer, <span class="keywordtype">int</span> nbytes);
<a name="l00075"></a>00075 
<a name="l00076"></a>00076   <span class="comment">/*</span>
<a name="l00077"></a>00077 <span class="comment">   * block until all outstanding writes have completed</span>
<a name="l00078"></a>00078 <span class="comment">   */</span>
<a name="l00079"></a><a class="code" href="classfusb__ephandle__generic.html#a7a7ef010b4fb8307ba4c6c29c88a020a">00079</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfusb__ephandle__generic.html#a7a7ef010b4fb8307ba4c6c29c88a020a">wait_for_completion</a> () { };
<a name="l00080"></a>00080 };
<a name="l00081"></a>00081 
<a name="l00082"></a>00082 <span class="preprocessor">#endif </span><span class="comment">/* _FUSB_GENERIC_H_ */</span>
<a name="l00083"></a>00083 
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="fusb__generic_8h.html">fusb_generic.h</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>