doc/www/doxygen/html/m__desktoptmpl_8h-source.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: m_desktoptmpl.h Source File</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><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><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="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>m_desktoptmpl.h</h1><a href="m__desktoptmpl_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>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       m_desktoptmpl.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Ease of use templates for the Desktop mode class</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_M_DESKTOPTMPL_H__</span>
  45 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_M_DESKTOPTMPL_H__</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  47 <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>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="m__desktop_8h.html" title="Mode class for the Desktop mode.">m_desktop.h</a>"</span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="parser_8h.html" title="Virtual parser wrapper.">parser.h</a>"</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="builder_8h.html" title="Virtual protocol packet builder wrapper.">builder.h</a>"</span>
  51 <a name="l00029"></a>00029
  52 <a name="l00030"></a>00030 <span class="keyword">namespace </span>Barry { <span class="keyword">namespace </span>Mode {
  53 <a name="l00031"></a>00031
  54 <a name="l00032"></a>00032 BXEXPORT <span class="keywordtype">void</span> LoadDatabase(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, Parser &amp;parser);
  55 <a name="l00033"></a>00033 BXEXPORT <span class="keywordtype">void</span> SaveDatabase(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, Builder &amp;builder);
  56 <a name="l00034"></a>00034
  57 <a name="l00035"></a>00035 <span class="keyword">template</span> &lt;<span class="keyword">class</span> RecordT, <span class="keyword">class</span> StorageT&gt;
  58 <a name="l00036"></a>00036 <span class="keywordtype">void</span> Desktop::LoadDatabaseByType(StorageT &amp;store)
  59 <a name="l00037"></a>00037 {
  60 <a name="l00038"></a>00038         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId = this-&gt;<a class="code" href="classBarry_1_1Mode_1_1Desktop.html#4e1dad976351ad48029dc80d5f05fae3" title="Get numeric database ID by name.">GetDBID</a>( RecordT::GetDBName() );
  61 <a name="l00039"></a>00039         <a class="code" href="classBarry_1_1RecordParser.html" title="Template class for easy creation of specific parser objects.">Barry::RecordParser&lt;RecordT, StorageT&gt;</a> parser(store);
  62 <a name="l00040"></a>00040         this-&gt;<a class="code" href="classBarry_1_1Mode_1_1Desktop.html#6bb1c96d6082575b5fa684dee2af51a6" title="Retrieve a database from the handheld device, using the given parser to parse the...">LoadDatabase</a>(dbId, parser);
  63 <a name="l00041"></a>00041 }
  64 <a name="l00042"></a>00042
  65 <a name="l00043"></a>00043 <span class="keyword">template</span> &lt;<span class="keyword">class</span> RecordT, <span class="keyword">class</span> StorageT&gt;
  66 <a name="l00044"></a>00044 <span class="keywordtype">void</span> Desktop::SaveDatabaseByType(StorageT &amp;store)
  67 <a name="l00045"></a>00045 {
  68 <a name="l00046"></a>00046         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId = this-&gt;<a class="code" href="classBarry_1_1Mode_1_1Desktop.html#4e1dad976351ad48029dc80d5f05fae3" title="Get numeric database ID by name.">GetDBID</a>( RecordT::GetDBName() );
  69 <a name="l00047"></a>00047         <a class="code" href="classBarry_1_1RecordBuilder.html" title="Template class for easy creation of specific protocol packet builder objects.">Barry::RecordBuilder&lt;RecordT, StorageT&gt;</a> build(store);
  70 <a name="l00048"></a>00048         SaveDatabase(dbId, build);
  71 <a name="l00049"></a>00049 }
  72 <a name="l00050"></a>00050
  73 <a name="l00051"></a>00051 <span class="keyword">template</span> &lt;<span class="keyword">class</span> StorageT&gt;
  74 <a name="l00052"></a>00052 <span class="keywordtype">void</span> Desktop::LoadDatabaseByName(<span class="keyword">const</span> std::string &amp;name, StorageT &amp;store)
  75 <a name="l00053"></a>00053 {
  76 <a name="l00054"></a>00054         <span class="keywordflow">if</span>( name == Contact::GetDBName() )
  77 <a name="l00055"></a>00055                 LoadDatabaseByType&lt;Contact&gt;(store);
  78 <a name="l00056"></a>00056         <span class="keywordflow">else</span> <span class="keywordflow">if</span>( name == Message::GetDBName() )
  79 <a name="l00057"></a>00057                 LoadDatabaseByType&lt;Message&gt;(store);
  80 <a name="l00058"></a>00058         <span class="keywordflow">else</span> <span class="keywordflow">if</span>( name == Calendar::GetDBName() )
  81 <a name="l00059"></a>00059                 LoadDatabaseByType&lt;Calendar&gt;(store);
  82 <a name="l00060"></a>00060         <span class="keywordflow">else</span>
  83 <a name="l00061"></a>00061                 <span class="keywordflow">throw</span> Error(<span class="stringliteral">"Unknown database name in LoadDatabaseByName: "</span> + name);
  84 <a name="l00062"></a>00062 }
  85 <a name="l00063"></a>00063
  86 <a name="l00064"></a>00064 <span class="keyword">template</span> &lt;<span class="keyword">class</span> StorageT&gt;
  87 <a name="l00065"></a>00065 <span class="keywordtype">void</span> Desktop::SaveDatabaseByName(<span class="keyword">const</span> std::string &amp;name, StorageT &amp;store)
  88 <a name="l00066"></a>00066 {
  89 <a name="l00067"></a>00067         <span class="keywordflow">if</span>( name == Contact::GetDBName() )
  90 <a name="l00068"></a>00068                 SaveDatabaseByType&lt;Contact&gt;(store);
  91 <a name="l00069"></a>00069         <span class="keywordflow">else</span> <span class="keywordflow">if</span>( name == Message::GetDBName() )
  92 <a name="l00070"></a>00070                 SaveDatabaseByType&lt;Message&gt;(store);
  93 <a name="l00071"></a>00071         <span class="keywordflow">else</span> <span class="keywordflow">if</span>( name == Calendar::GetDBName() )
  94 <a name="l00072"></a>00072                 SaveDatabaseByType&lt;Calendar&gt;(store);
  95 <a name="l00073"></a>00073         <span class="keywordflow">else</span>
  96 <a name="l00074"></a>00074                 <span class="keywordflow">throw</span> Error(<span class="stringliteral">"Unknown database name in SaveDatabaseByName: "</span> + name);
  97 <a name="l00075"></a>00075 }
  98 <a name="l00076"></a>00076
  99 <a name="l00077"></a>00077 <span class="keyword">template</span> &lt;<span class="keyword">class</span> RecordT&gt;
 100 <a name="l00078"></a>00078 <span class="keywordtype">void</span> Desktop::AddRecordByType(uint32_t recordId, <span class="keyword">const</span> RecordT &amp;rec)
 101 <a name="l00079"></a>00079 {
 102 <a name="l00080"></a>00080         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId = this-&gt;<a class="code" href="classBarry_1_1Mode_1_1Desktop.html#4e1dad976351ad48029dc80d5f05fae3" title="Get numeric database ID by name.">GetDBID</a>( RecordT::GetDBName() );
 103 <a name="l00081"></a>00081         <span class="comment">// FIXME - I know this is a convenience template, but it still</span>
 104 <a name="l00082"></a>00082         <span class="comment">// hurts making a temporary copy just to set the record ID...</span>
 105 <a name="l00083"></a>00083         <span class="comment">// create a better API for this.</span>
 106 <a name="l00084"></a>00084         RecordT r = rec;
 107 <a name="l00085"></a>00085         r.SetIds(RecordT::GetDefaultRecType(), recordId);
 108 <a name="l00086"></a>00086         <a class="code" href="classBarry_1_1RecordFetch.html" title="Generic record fetch class, to help with using records without builder classes.">Barry::RecordFetch&lt;RecordT&gt;</a> fetch(r);
 109 <a name="l00087"></a>00087         <a class="code" href="classBarry_1_1RecordBuilder.html" title="Template class for easy creation of specific protocol packet builder objects.">Barry::RecordBuilder&lt;RecordT, Barry::RecordFetch&lt;RecordT&gt;</a> &gt; build(fetch);
 110 <a name="l00088"></a>00088         this-&gt;<a class="code" href="classBarry_1_1Mode_1_1Desktop.html#0fec0d31ff496974acfc15fdc75f074a" title="Adds a record to the specified database.">AddRecord</a>(dbId, build);
 111 <a name="l00089"></a>00089 }
 112 <a name="l00090"></a>00090
 113 <a name="l00091"></a>00091
 114 <a name="l00092"></a>00092 }} <span class="comment">// namespace Barry::Mode</span>
 115 <a name="l00093"></a>00093
 116 <a name="l00094"></a>00094 <span class="preprocessor">#endif</span>
 117 <a name="l00095"></a>00095 <span class="preprocessor"></span>
 118 </pre></div></div>
 119 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 00:01:52 2009 for Barry by&nbsp;
 120 <a href="http://www.doxygen.org/index.html">
 121 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 122 </body>
 123 </html>