<!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>Barry: m_desktop.h Source File</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.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>m_desktop.h</h1><a href="m__desktop_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file m_desktop.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Mode class for the Desktop mode</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_M_DESKTOP_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_M_DESKTOP_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="m__mode__base_8h.html" title="Base for mode classes.">m_mode_base.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="socket_8h.html" title="Class wrapper to encapsulate the Blackberry USB logical socket.">socket.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">namespace </span>Barry {
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">// forward declarations</span>
<a name="l00033"></a>00033 <span class="keyword">class </span>Parser;
<a name="l00034"></a>00034 <span class="keyword">class </span>Builder;
<a name="l00035"></a>00035 <span class="keyword">class </span>IConverter;
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">namespace </span>Mode {
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">//</span>
<a name="l00040"></a>00040 <span class="comment">// Desktop class</span>
<a name="l00041"></a>00041 <span class="comment">//</span><span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment">/// The main interface class to the device databases.</span>
<a name="l00043"></a>00043 <span class="comment">///</span>
<a name="l00044"></a>00044 <span class="comment">/// To use this class, use the following steps:</span>
<a name="l00045"></a>00045 <span class="comment">///</span>
<a name="l00046"></a>00046 <span class="comment">/// - Create a Controller object (see Controller class for more details)</span>
<a name="l00047"></a>00047 <span class="comment">/// - Create this Mode::Desktop object, passing in the Controller</span>
<a name="l00048"></a>00048 <span class="comment">/// object during construction</span>
<a name="l00049"></a>00049 <span class="comment">/// - Call Open() to open database socket and finish constructing.</span>
<a name="l00050"></a>00050 <span class="comment">/// - Call GetDBDB() to get the device's database database</span>
<a name="l00051"></a>00051 <span class="comment">/// - Call GetDBID() to get a database ID by name</span>
<a name="l00052"></a>00052 <span class="comment">/// - Call LoadDatabase() to retrieve and store a database</span>
<a name="l00053"></a>00053 <span class="comment">///</span>
<a name="l00054"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html">00054</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Desktop</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes.">Mode</a>
<a name="l00055"></a>00055 {
<a name="l00056"></a>00056 <span class="keyword">public</span>:
<a name="l00057"></a>00057 <span class="keyword">enum</span> CommandType { Unknown, DatabaseAccess };
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">private</span>:
<a name="l00060"></a>00060 <a class="code" href="classBarry_1_1CommandTable.html">CommandTable</a> m_commandTable;
<a name="l00061"></a>00061 <a class="code" href="classBarry_1_1DatabaseDatabase.html">DatabaseDatabase</a> m_dbdb;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">// external objects (optional, can be null)</span>
<a name="l00064"></a>00064 <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *m_ic;
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">protected</span>:
<a name="l00067"></a>00067 <span class="keywordtype">void</span> LoadCommandTable();
<a name="l00068"></a>00068 <span class="keywordtype">void</span> LoadDBDB();
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> //////////////////////////////////</span>
<a name="l00071"></a>00071 <span class="comment"></span> <span class="comment">// overrides</span>
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">void</span> OnOpen();
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keyword">public</span>:
<a name="l00076"></a>00076 <a class="code" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Desktop</a>(<a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> &con);
<a name="l00077"></a>00077 <a class="code" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Desktop</a>(<a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> &con, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> &ic);
<a name="l00078"></a>00078 ~<a class="code" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Desktop</a>();
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> //////////////////////////////////</span>
<a name="l00081"></a>00081 <span class="comment"></span> <span class="comment">// meta access</span>
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /// Returns DatabaseDatabase object for this connection.</span>
<a name="l00084"></a>00084 <span class="comment"> /// Must call Open() first, which loads the DBDB.</span>
<a name="l00085"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#a41d83954c0bcc4b3a707c7501269c5b9">00085</a> <span class="comment"></span> <span class="keyword">const</span> <a class="code" href="classBarry_1_1DatabaseDatabase.html">DatabaseDatabase</a>& <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#a41d83954c0bcc4b3a707c7501269c5b9" title="Returns DatabaseDatabase object for this connection.">GetDBDB</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_dbdb; }
<a name="l00086"></a>00086 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetDBID(<span class="keyword">const</span> std::string &name) <span class="keyword">const</span>;
<a name="l00087"></a>00087 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetDBCommand(CommandType ct);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keywordtype">void</span> SetIConverter(<span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> &ic);
<a name="l00090"></a>00090 <span class="comment"></span>
<a name="l00091"></a>00091 <span class="comment"> //////////////////////////////////</span>
<a name="l00092"></a>00092 <span class="comment"></span> <span class="comment">// Desktop mode - database specific</span>
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment">// dirty flag related functions, for sync operations</span>
<a name="l00095"></a>00095 <span class="keywordtype">void</span> GetRecordStateTable(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <a class="code" href="classBarry_1_1RecordStateTable.html">RecordStateTable</a> &result);
<a name="l00096"></a>00096 <span class="keywordtype">void</span> AddRecord(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> &build); <span class="comment">// RecordId is</span>
<a name="l00097"></a>00097 <span class="comment">// retrieved from build, and duplicate IDs are allowed,</span>
<a name="l00098"></a>00098 <span class="comment">// but *not* recommended!</span>
<a name="l00099"></a>00099 <span class="keywordtype">void</span> GetRecord(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex, <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &parser);
<a name="l00100"></a>00100 <span class="keywordtype">void</span> SetRecord(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex, <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> &build);
<a name="l00101"></a>00101 <span class="keywordtype">void</span> ClearDirty(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex);
<a name="l00102"></a>00102 <span class="keywordtype">void</span> DeleteRecord(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="comment">// pure load/save operations</span>
<a name="l00105"></a>00105 <span class="keywordtype">void</span> LoadDatabase(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &parser);
<a name="l00106"></a>00106 <span class="keywordtype">void</span> ClearDatabase(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId);
<a name="l00107"></a>00107 <span class="keywordtype">void</span> SaveDatabase(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> &builder);
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">template</span> <<span class="keyword">class</span> RecordT, <span class="keyword">class</span> StorageT> <span class="keywordtype">void</span> LoadDatabaseByType(StorageT &store);
<a name="l00110"></a>00110 <span class="keyword">template</span> <<span class="keyword">class</span> RecordT, <span class="keyword">class</span> StorageT> <span class="keywordtype">void</span> SaveDatabaseByType(StorageT &store);
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keyword">template</span> <<span class="keyword">class</span> StorageT> <span class="keywordtype">void</span> LoadDatabaseByName(<span class="keyword">const</span> std::string &name, StorageT &store);
<a name="l00113"></a>00113 <span class="keyword">template</span> <<span class="keyword">class</span> StorageT> <span class="keywordtype">void</span> SaveDatabaseByName(<span class="keyword">const</span> std::string &name, StorageT &store);
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">template</span> <<span class="keyword">class</span> RecordT> <span class="keywordtype">void</span> AddRecordByType(uint32_t recordId, <span class="keyword">const</span> RecordT &rec);
<a name="l00116"></a>00116
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118
<a name="l00119"></a>00119 }} <span class="comment">// namespace Barry::Mode</span>
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="preprocessor">#endif</span>
<a name="l00122"></a>00122 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
