doc/www/doxygen/html/classBarry_1_1Mode_1_1DBLoader.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::DBLoader 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_1DBLoader.html">DBLoader</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>Barry::Mode::DBLoader Class Reference</h1><!-- doxytag: class="Barry::Mode::DBLoader" --><code>#include &lt;<a class="el" href="m__desktop_8h-source.html">m_desktop.h</a>&gt;</code>
  32 <p>
  33 <div class="dynheader">
  34 Collaboration diagram for Barry::Mode::DBLoader:</div>
  35 <div class="dynsection">
  36 <p><center><img src="classBarry_1_1Mode_1_1DBLoader__coll__graph.png" border="0" usemap="#Barry_1_1Mode_1_1DBLoader__coll__map" alt="Collaboration graph"></center>
  37 <map name="Barry_1_1Mode_1_1DBLoader__coll__map">
  38 <area shape="rect" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets." alt="" coords="1680,265,1800,292"><area shape="rect" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases." alt="" coords="1436,316,1583,343"><area shape="rect" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry..." alt="" coords="1135,443,1255,469"><area shape="rect" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes." alt="" coords="1129,392,1260,419"><area shape="rect" href="classBarry_1_1Controller.html" title="The main interface class." alt="" coords="875,247,989,273"><area shape="rect" title="STL class." alt="" coords="332,440,412,467"><area shape="rect" title="STL class." alt="" coords="7,440,172,467"><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,24,152,51"><area shape="rect" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two&#45;way iconv_t handle pair." alt="" coords="865,492,999,519"></map>
  39 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  40
  41 <p>
  42 <a href="classBarry_1_1Mode_1_1DBLoader-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  43 Database Loader operation class.
  44 <p>
  45 Encapsulates the load / save logic of <a class="el" href="classBarry_1_1Mode_1_1Desktop.html#6bb1c96d6082575b5fa684dee2af51a6" title="Retrieve a database from the handheld device, using the given parser to parse the...">Desktop::LoadDatabase()</a> and someday Desktop::SaveDatabase() in such a way that the loading of individual records is controllable by the user, instead of using the parser callback mechanism.<p>
  46 This class can be reused to load / save multiple databases, but do not call <a class="el" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Desktop</a> members while a load operation is in progress.
  47 <p>Definition at line <a class="el" href="m__desktop_8h-source.html#l00142">142</a> of file <a class="el" href="m__desktop_8h-source.html">m_desktop.h</a>.</p>
  48 <table border="0" cellpadding="0" cellspacing="0">
  49 <tr><td></td></tr>
  50 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  51 <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_1DBLoader.html#951ebb66ec127c4ee47ead54ac21dbca">IsBusy</a> () const </td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not call <a class="el" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Desktop</a> members if this is true.  <a href="#951ebb66ec127c4ee47ead54ac21dbca"></a><br></td></tr>
  54 </table>
  55 <hr><h2>Member Function Documentation</h2>
  56 <a class="anchor" name="951ebb66ec127c4ee47ead54ac21dbca"></a><!-- doxytag: member="Barry::Mode::DBLoader::IsBusy" ref="951ebb66ec127c4ee47ead54ac21dbca" args="() const " -->
  57 <div class="memitem">
  58 <div class="memproto">
  59       <table class="memname">
  60         <tr>
  61           <td class="memname">bool Barry::Mode::DBLoader::IsBusy           </td>
  62           <td>(</td>
  63           <td class="paramname">          </td>
  64           <td>&nbsp;)&nbsp;</td>
  65           <td> const<code> [inline]</code></td>
  66         </tr>
  67       </table>
  68 </div>
  69 <div class="memdoc">
  70
  71 <p>
  72 Do not call <a class="el" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Desktop</a> members if this is true.
  73 <p>
  74
  75 <p>Definition at line <a class="el" href="m__desktop_8h-source.html#l00155">155</a> of file <a class="el" href="m__desktop_8h-source.html">m_desktop.h</a>.</p>
  76
  77 <p>Referenced by <a class="el" href="m__desktop_8cc-source.html#l00612">Barry::DeviceBuilder::FetchRecord()</a>.</p>
  78
  79 <p>
  80 <div class="dynheader">
  81 Here is the caller graph for this function:</div>
  82 <div class="dynsection">
  83 <p><center><img src="classBarry_1_1Mode_1_1DBLoader_951ebb66ec127c4ee47ead54ac21dbca_icgraph.png" border="0" usemap="#classBarry_1_1Mode_1_1DBLoader_951ebb66ec127c4ee47ead54ac21dbca_icgraph_map" alt=""></center>
  84 <map name="classBarry_1_1Mode_1_1DBLoader_951ebb66ec127c4ee47ead54ac21dbca_icgraph_map">
  85 <area shape="rect" href="classBarry_1_1DeviceBuilder.html#3eb2238b584aadac8af2f511cd2ba245" title="Same as BuildRecord, but does not care about any offsets." alt="" coords="263,5,484,32"><area shape="rect" href="classBarry_1_1DeviceBuilder.html#292a7d4ee73590ce55c5d866739417ec" title="Called to build the record field data." alt="" coords="533,5,752,32"></map>
  86 </div>
  87
  88 </div>
  89 </div><p>
  90 <hr>The documentation for this class was generated from the following files:<ul>
  91 <li><a class="el" href="m__desktop_8h-source.html">m_desktop.h</a><li><a class="el" href="m__desktop_8cc-source.html">m_desktop.cc</a></ul>
  92 </div>
  93 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:46 2011 for Barry by&nbsp;
  94 <a href="http://www.doxygen.org/index.html">
  95 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  96 </body>
  97 </html>