doc/www/doxygen/html/classBarry_1_1Mode_1_1JavaLoader.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::JavaLoader 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_1JavaLoader.html">JavaLoader</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>Barry::Mode::JavaLoader Class Reference</h1><!-- doxytag: class="Barry::Mode::JavaLoader" --><!-- doxytag: inherits="Barry::Mode::Mode" --><code>#include &lt;<a class="el" href="m__javaloader_8h-source.html">m_javaloader.h</a>&gt;</code>
  32 <p>
  33 <div class="dynheader">
  34 Inheritance diagram for Barry::Mode::JavaLoader:</div>
  35 <div class="dynsection">
  36 <p><center><img src="classBarry_1_1Mode_1_1JavaLoader__inherit__graph.png" border="0" usemap="#Barry_1_1Mode_1_1JavaLoader__inherit__map" alt="Inheritance graph"></center>
  37 <map name="Barry_1_1Mode_1_1JavaLoader__inherit__map">
  38 <area shape="rect" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes." alt="" coords="24,5,155,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::JavaLoader:</div>
  42 <div class="dynsection">
  43 <p><center><img src="classBarry_1_1Mode_1_1JavaLoader__coll__graph.png" border="0" usemap="#Barry_1_1Mode_1_1JavaLoader__coll__map" alt="Collaboration graph"></center>
  44 <map name="Barry_1_1Mode_1_1JavaLoader__coll__map">
  45 <area shape="rect" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes." alt="" coords="1063,216,1193,243"><area shape="rect" href="classBarry_1_1Controller.html" title="The main interface class." alt="" coords="857,216,972,243"><area shape="rect" title="STL class." alt="" coords="332,85,412,112"><area shape="rect" title="STL class." alt="" coords="7,85,172,112"><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,399,152,425"></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_1JavaLoader-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  50 The main interface class to the java program loader protocol.
  51 <p>
  52 To use this class, use the following steps:<p>
  53 <ul>
  54 <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_1JavaLoader.html" title="The main interface class to the java program loader protocol.">Mode::JavaLoader</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 database socket and finish constructing.</li><li>Call LoadDatabase() to retrieve and store a database </li></ul>
  55
  56 <p>Definition at line <a class="el" href="m__javaloader_8h-source.html#l00220">220</a> of file <a class="el" href="m__javaloader_8h-source.html">m_javaloader.h</a>.</p>
  57 <table border="0" cellpadding="0" cellspacing="0">
  58 <tr><td></td></tr>
  59 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  60 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html#adb74f46b334a4b1ab17b9e060a63997">StopStream</a> ()</td></tr>
  61
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Must be called at the end of a <a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html" title="The main interface class to the java program loader protocol.">JavaLoader</a> session.  <a href="#adb74f46b334a4b1ab17b9e060a63997"></a><br></td></tr>
  63 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html#237c4ac1e59f5bbcfc57a7e6eec1cf11">GetScreenshot</a> (JLScreenInfo &amp;info, Data &amp;image)</td></tr>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Downloads screenshot from device, and fills info with size data and the given Data buffer image with the bitmap.  <a href="#237c4ac1e59f5bbcfc57a7e6eec1cf11"></a><br></td></tr>
  66 </table>
  67 <hr><h2>Member Function Documentation</h2>
  68 <a class="anchor" name="adb74f46b334a4b1ab17b9e060a63997"></a><!-- doxytag: member="Barry::Mode::JavaLoader::StopStream" ref="adb74f46b334a4b1ab17b9e060a63997" args="()" -->
  69 <div class="memitem">
  70 <div class="memproto">
  71       <table class="memname">
  72         <tr>
  73           <td class="memname">bool Barry::Mode::JavaLoader::StopStream           </td>
  74           <td>(</td>
  75           <td class="paramname">          </td>
  76           <td>&nbsp;)&nbsp;</td>
  77           <td></td>
  78         </tr>
  79       </table>
  80 </div>
  81 <div class="memdoc">
  82
  83 <p>
  84 Must be called at the end of a <a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html" title="The main interface class to the java program loader protocol.">JavaLoader</a> session.
  85 <p>
  86 The JL_GOODBYE command is sent to the device. When the device responds with RESET_REQUIRED the device reset command will be sent when the socket is closed.<p>
  87 <dl class="return" compact><dt><b>Returns:</b></dt><dd>true when a device reset was required </dd></dl>
  88
  89 <p>Definition at line <a class="el" href="m__javaloader_8cc-source.html#l00474">474</a> of file <a class="el" href="m__javaloader_8cc-source.html">m_javaloader.cc</a>.</p>
  90
  91 <p>References <a class="el" href="packet_8h-source.html#l00226">Barry::JLPacket::Goodbye()</a>, <a class="el" href="controller_8h-source.html#l00100">Barry::Controller::m_zero</a>, and <a class="el" href="error_8h-source.html#l00212">Barry::BadPacket::response()</a>.</p>
  92
  93 <p>
  94 <div class="dynheader">
  95 Here is the call graph for this function:</div>
  96 <div class="dynsection">
  97 <p><center><img src="classBarry_1_1Mode_1_1JavaLoader_adb74f46b334a4b1ab17b9e060a63997_cgraph.png" border="0" usemap="#classBarry_1_1Mode_1_1JavaLoader_adb74f46b334a4b1ab17b9e060a63997_cgraph_map" alt=""></center>
  98 <map name="classBarry_1_1Mode_1_1JavaLoader_adb74f46b334a4b1ab17b9e060a63997_cgraph_map">
  99 <area shape="rect" href="classBarry_1_1JLPacket.html#15ed6b5e8f0d5752d46ad4682f8cff81" title="Barry::JLPacket::Goodbye" alt="" coords="304,5,480,32"><area shape="rect" href="classBarry_1_1BadPacket.html#efecf010326a51ee9e762d6f24230911" title="Barry::BadPacket::response" alt="" coords="300,56,484,83"></map>
 100 </div>
 101
 102 </div>
 103 </div><p>
 104 <a class="anchor" name="237c4ac1e59f5bbcfc57a7e6eec1cf11"></a><!-- doxytag: member="Barry::Mode::JavaLoader::GetScreenshot" ref="237c4ac1e59f5bbcfc57a7e6eec1cf11" args="(JLScreenInfo &amp;info, Data &amp;image)" -->
 105 <div class="memitem">
 106 <div class="memproto">
 107       <table class="memname">
 108         <tr>
 109           <td class="memname">void Barry::Mode::JavaLoader::GetScreenshot           </td>
 110           <td>(</td>
 111           <td class="paramtype">JLScreenInfo &amp;&nbsp;</td>
 112           <td class="paramname"> <em>info</em>, </td>
 113         </tr>
 114         <tr>
 115           <td class="paramkey"></td>
 116           <td></td>
 117           <td class="paramtype">Data &amp;&nbsp;</td>
 118           <td class="paramname"> <em>image</em></td><td>&nbsp;</td>
 119         </tr>
 120         <tr>
 121           <td></td>
 122           <td>)</td>
 123           <td></td><td></td><td></td>
 124         </tr>
 125       </table>
 126 </div>
 127 <div class="memdoc">
 128
 129 <p>
 130 Downloads screenshot from device, and fills info with size data and the given Data buffer image with the bitmap.
 131 <p>
 132
 133 <p>Definition at line <a class="el" href="m__javaloader_8cc-source.html#l00615">615</a> of file <a class="el" href="m__javaloader_8cc-source.html">m_javaloader.cc</a>.</p>
 134
 135 <p>References <a class="el" href="packet_8h-source.html#l00232">Barry::JLPacket::GetData()</a>, <a class="el" href="packet_8cc-source.html#l00658">Barry::JLPacket::GetScreenshot()</a>, and <a class="el" href="packet_8cc-source.html#l00569">Barry::JLPacket::Size()</a>.</p>
 136
 137 <p>
 138 <div class="dynheader">
 139 Here is the call graph for this function:</div>
 140 <div class="dynsection">
 141 <p><center><img src="classBarry_1_1Mode_1_1JavaLoader_237c4ac1e59f5bbcfc57a7e6eec1cf11_cgraph.png" border="0" usemap="#classBarry_1_1Mode_1_1JavaLoader_237c4ac1e59f5bbcfc57a7e6eec1cf11_cgraph_map" alt=""></center>
 142 <map name="classBarry_1_1Mode_1_1JavaLoader_237c4ac1e59f5bbcfc57a7e6eec1cf11_cgraph_map">
 143 <area shape="rect" href="classBarry_1_1JLPacket.html#e4b045bdc2048a9e4ea9be5b2bbcf1b8" title="Barry::JLPacket::GetData" alt="" coords="337,5,508,32"><area shape="rect" href="classBarry_1_1JLPacket.html#e31231ae3bd3525a722e2b94f6c67a96" title="Barry::JLPacket::GetScreenshot" alt="" coords="317,56,528,83"><area shape="rect" href="classBarry_1_1JLPacket.html#c0c7f72182eb34fd287b7c98c6979738" title="Barry::JLPacket::Size" alt="" coords="348,107,497,133"></map>
 144 </div>
 145
 146 </div>
 147 </div><p>
 148 <hr>The documentation for this class was generated from the following files:<ul>
 149 <li><a class="el" href="m__javaloader_8h-source.html">m_javaloader.h</a><li><a class="el" href="m__javaloader_8cc-source.html">m_javaloader.cc</a></ul>
 150 </div>
 151 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:46 2011 for Barry by&nbsp;
 152 <a href="http://www.doxygen.org/index.html">
 153 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 154 </body>
 155 </html>