doc/www/doxygen/html/classBarry_1_1Mode_1_1RawChannel.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: Barry::Mode::RawChannel Class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   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><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  15       <li><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="tabs">
  20     <ul>
  21       <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
  22       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  23       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25     </ul>
  26   </div>
  27   <div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<b>Mode</b>::<a class="el" href="classBarry_1_1Mode_1_1RawChannel.html">RawChannel</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>Barry::Mode::RawChannel Class Reference</h1><!-- doxytag: class="Barry::Mode::RawChannel" --><!-- doxytag: inherits="Barry::Mode::Mode" --><code>#include &lt;<a class="el" href="m__raw__channel_8h-source.html">m_raw_channel.h</a>&gt;</code>
  32 <p>
  33 <div class="dynheader">
  34 Inheritance diagram for Barry::Mode::RawChannel:</div>
  35 <div class="dynsection">
  36 <p><center><img src="classBarry_1_1Mode_1_1RawChannel__inherit__graph.png" border="0" usemap="#Barry_1_1Mode_1_1RawChannel__inherit__map" alt="Inheritance graph"></center>
  37 <map name="Barry_1_1Mode_1_1RawChannel__inherit__map">
  38 <area shape="rect" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes." alt="" coords="25,5,156,32"></map>
  39 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  40 <div class="dynheader">
  41 Collaboration diagram for Barry::Mode::RawChannel:</div>
  42 <div class="dynsection">
  43 <p><center><img src="classBarry_1_1Mode_1_1RawChannel__coll__graph.png" border="0" usemap="#Barry_1_1Mode_1_1RawChannel__coll__map" alt="Collaboration graph"></center>
  44 <map name="Barry_1_1Mode_1_1RawChannel__coll__map">
  45 <area shape="rect" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes." alt="" coords="1121,152,1252,179"><area shape="rect" href="classBarry_1_1Controller.html" title="The main interface class." alt="" coords="857,247,972,273"><area shape="rect" title="STL class." alt="" coords="332,49,412,76"><area shape="rect" title="STL class." alt="" coords="7,49,172,76"><area shape="rect" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory..." alt="" coords="27,204,152,231"></map>
  46 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  47
  48 <p>
  49 <a href="classBarry_1_1Mode_1_1RawChannel-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  50 The main class for creating a raw channel session.
  51 <p>
  52 To use this class, use the following steps:<p>
  53 <ul>
  54 <li>Implement RawChannelDataCallback<ul>
  55 <li>Create a <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> object (see <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> class for more details)</li><li>Create this <a class="el" href="classBarry_1_1Mode_1_1RawChannel.html" title="The main class for creating a raw channel session.">Mode::RawChannel</a> object, passing in the <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> object during construction</li><li>Call <a class="el" href="classBarry_1_1Mode_1_1Mode.html#1110243f16be2b647ed9810da27abe11" title="Select device mode.">Open()</a> to open the channel and finish constructing.</li><li>Call GetData() to fetch data</li><li>Call SendData() to send data </li></ul>
  56 </li></ul>
  57
  58 <p>Definition at line <a class="el" href="m__raw__channel_8h-source.html#l00074">74</a> of file <a class="el" href="m__raw__channel_8h-source.html">m_raw_channel.h</a>.</p>
  59 <table border="0" cellpadding="0" cellspacing="0">
  60 <tr><td></td></tr>
  61 </table>
  62 <hr>The documentation for this class was generated from the following files:<ul>
  63 <li><a class="el" href="m__raw__channel_8h-source.html">m_raw_channel.h</a><li><a class="el" href="m__raw__channel_8cc-source.html">m_raw_channel.cc</a></ul>
  64 </div>
  65 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:47 2011 for Barry by&nbsp;
  66 <a href="http://www.doxygen.org/index.html">
  67 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  68 </body>
  69 </html>