Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 2aa62c5bbb658df1fece777472a7bcf2 > files > 2367

barry-devel-docs-0.17-0.3.20100730git.fc14.noarch.rpm

<!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: record.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&nbsp;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&nbsp;List</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
  </div>
</div>
<div class="contents">
<h1>record.h</h1><a href="record_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       record.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Blackberry database record classes.  Help translate data</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///             from data packets to useful structurs, and back.</span>
<a name="l00005"></a>00005 <span class="comment"></span><span class="comment">///             This header provides the common types and classes</span>
<a name="l00006"></a>00006 <span class="comment"></span><span class="comment">///             used by the general record parser classes in the</span>
<a name="l00007"></a>00007 <span class="comment"></span><span class="comment">///             r_*.h files.  Only application-safe API stuff goes in</span>
<a name="l00008"></a>00008 <span class="comment"></span><span class="comment">///             here.  Internal library types go in record-internal.h</span>
<a name="l00009"></a>00009 <span class="comment"></span><span class="comment">///</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment">    Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
<a name="l00015"></a>00015 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
<a name="l00016"></a>00016 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00017"></a>00017 <span class="comment">    (at your option) any later version.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
<a name="l00020"></a>00020 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00021"></a>00021 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00022"></a>00022 <span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
<a name="l00024"></a>00024 <span class="comment">    root directory of this project for more details.</span>
<a name="l00025"></a>00025 <span class="comment">*/</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef __BARRY_RECORD_H__</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_RECORD_H__</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &quot;<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>&quot;</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;iosfwd&gt;</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;map&gt;</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="comment">// forward declarations</span>
<a name="l00038"></a>00038 <span class="keyword">namespace </span>Barry { <span class="keyword">class </span>Data; }
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="keyword">namespace </span>Barry {
<a name="l00041"></a>00041 
<a name="l00042"></a>00042 <span class="comment">//</span>
<a name="l00043"></a>00043 <span class="comment">// NOTE:  All classes here must be container-safe!  Perhaps add sorting</span>
<a name="l00044"></a>00044 <span class="comment">//        operators in the future.</span>
<a name="l00045"></a>00045 <span class="comment">//</span>
<a name="l00046"></a>00046 
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 
<a name="l00049"></a><a class="code" href="structBarry_1_1CommandTableCommand.html">00049</a> <span class="keyword">struct </span>BXEXPORT <a class="code" href="structBarry_1_1CommandTableCommand.html">CommandTableCommand</a>
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Code;
<a name="l00052"></a>00052         std::string Name;
<a name="l00053"></a>00053 };
<a name="l00054"></a>00054 
<a name="l00055"></a><a class="code" href="classBarry_1_1CommandTable.html">00055</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1CommandTable.html">CommandTable</a>
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 <span class="keyword">public</span>:
<a name="l00058"></a>00058         <span class="keyword">typedef</span> <a class="code" href="structBarry_1_1CommandTableCommand.html">CommandTableCommand</a> <a class="code" href="structBarry_1_1CommandTableCommand.html">Command</a>;
<a name="l00059"></a>00059         <span class="keyword">typedef</span> std::vector&lt;Command&gt; CommandArrayType;
<a name="l00060"></a>00060 
<a name="l00061"></a>00061         CommandArrayType Commands;
<a name="l00062"></a>00062 
<a name="l00063"></a>00063 <span class="keyword">private</span>:
<a name="l00064"></a>00064         <a class="code" href="structBXLOCAL.html">BXLOCAL</a> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
<a name="l00065"></a>00065                 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end);
<a name="l00066"></a>00066 <span class="keyword">public</span>:
<a name="l00067"></a>00067         <a class="code" href="classBarry_1_1CommandTable.html">CommandTable</a>();
<a name="l00068"></a>00068         ~<a class="code" href="classBarry_1_1CommandTable.html">CommandTable</a>();
<a name="l00069"></a>00069 
<a name="l00070"></a>00070         <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &amp;data, <span class="keywordtype">size_t</span> offset);
<a name="l00071"></a>00071         <span class="keywordtype">void</span> Clear();
<a name="l00072"></a>00072 
<a name="l00073"></a>00073         <span class="comment">// returns 0 if unable to find command name, which is safe, since</span>
<a name="l00074"></a>00074         <span class="comment">// 0 is a special command that shouldn&#39;t be in the table anyway</span>
<a name="l00075"></a>00075         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetCommand(<span class="keyword">const</span> std::string &amp;name) <span class="keyword">const</span>;
<a name="l00076"></a>00076 
<a name="l00077"></a>00077         <span class="keywordtype">void</span> Dump(std::ostream &amp;os) <span class="keyword">const</span>;
<a name="l00078"></a>00078 };
<a name="l00079"></a>00079 
<a name="l00080"></a>00080 BXEXPORT <span class="keyword">inline</span> std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> <a class="code" href="classBarry_1_1CommandTable.html">CommandTable</a> &amp;command) {
<a name="l00081"></a>00081         command.Dump(os);
<a name="l00082"></a>00082         <span class="keywordflow">return</span> os;
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084 
<a name="l00085"></a>00085 
<a name="l00086"></a>00086 
<a name="l00087"></a><a class="code" href="structBarry_1_1RecordStateTableState.html">00087</a> <span class="keyword">struct </span>BXEXPORT <a class="code" href="structBarry_1_1RecordStateTableState.html">RecordStateTableState</a>
<a name="l00088"></a>00088 {
<a name="l00089"></a>00089         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Index;
<a name="l00090"></a>00090         uint32_t RecordId;
<a name="l00091"></a>00091         <span class="keywordtype">bool</span> Dirty;
<a name="l00092"></a>00092         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RecType;
<a name="l00093"></a>00093         std::string Unknown2;
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095 
<a name="l00096"></a><a class="code" href="classBarry_1_1RecordStateTable.html">00096</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1RecordStateTable.html">RecordStateTable</a>
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 <span class="keyword">public</span>:
<a name="l00099"></a>00099         <span class="keyword">typedef</span> <a class="code" href="structBarry_1_1RecordStateTableState.html">RecordStateTableState</a> <a class="code" href="structBarry_1_1RecordStateTableState.html">State</a>;
<a name="l00100"></a>00100         <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> IndexType;
<a name="l00101"></a>00101         <span class="keyword">typedef</span> std::map&lt;IndexType, State&gt; StateMapType;
<a name="l00102"></a>00102 
<a name="l00103"></a>00103         StateMapType StateMap;
<a name="l00104"></a>00104 
<a name="l00105"></a>00105 <span class="keyword">private</span>:
<a name="l00106"></a>00106         <span class="keyword">mutable</span> IndexType m_LastNewRecordId;
<a name="l00107"></a>00107 
<a name="l00108"></a>00108 <span class="keyword">private</span>:
<a name="l00109"></a>00109         <a class="code" href="structBXLOCAL.html">BXLOCAL</a> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
<a name="l00110"></a>00110                 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end);
<a name="l00111"></a>00111 
<a name="l00112"></a>00112 <span class="keyword">public</span>:
<a name="l00113"></a>00113         <a class="code" href="classBarry_1_1RecordStateTable.html">RecordStateTable</a>();
<a name="l00114"></a>00114         ~<a class="code" href="classBarry_1_1RecordStateTable.html">RecordStateTable</a>();
<a name="l00115"></a>00115 
<a name="l00116"></a>00116         <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &amp;data);
<a name="l00117"></a>00117         <span class="keywordtype">void</span> Clear();
<a name="l00118"></a>00118 
<a name="l00119"></a>00119         <span class="keywordtype">bool</span> GetIndex(uint32_t RecordId, IndexType *pFoundIndex = 0) <span class="keyword">const</span>;
<a name="l00120"></a>00120         uint32_t MakeNewRecordId() <span class="keyword">const</span>;
<a name="l00121"></a>00121 
<a name="l00122"></a>00122         <span class="keywordtype">void</span> Dump(std::ostream &amp;os) <span class="keyword">const</span>;
<a name="l00123"></a>00123 };
<a name="l00124"></a>00124 
<a name="l00125"></a>00125 BXEXPORT <span class="keyword">inline</span> std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> <a class="code" href="classBarry_1_1RecordStateTable.html">RecordStateTable</a> &amp;rst) {
<a name="l00126"></a>00126         rst.Dump(os);
<a name="l00127"></a>00127         <span class="keywordflow">return</span> os;
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129 
<a name="l00130"></a>00130 
<a name="l00131"></a>00131 
<a name="l00132"></a><a class="code" href="structBarry_1_1DatabaseItem.html">00132</a> <span class="keyword">struct </span>BXEXPORT <a class="code" href="structBarry_1_1DatabaseItem.html">DatabaseItem</a>
<a name="l00133"></a>00133 {
<a name="l00134"></a>00134         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Number;
<a name="l00135"></a>00135         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RecordCount;
<a name="l00136"></a>00136         std::string Name;
<a name="l00137"></a>00137 };
<a name="l00138"></a>00138 
<a name="l00139"></a><a class="code" href="classBarry_1_1DatabaseDatabase.html">00139</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1DatabaseDatabase.html">DatabaseDatabase</a>
<a name="l00140"></a>00140 {
<a name="l00141"></a>00141 <span class="keyword">public</span>:
<a name="l00142"></a>00142         <span class="keyword">typedef</span> <a class="code" href="structBarry_1_1DatabaseItem.html">DatabaseItem</a> <a class="code" href="structBarry_1_1DatabaseItem.html">Database</a>;
<a name="l00143"></a>00143         <span class="keyword">typedef</span> std::vector&lt;Database&gt; DatabaseArrayType;
<a name="l00144"></a>00144 
<a name="l00145"></a>00145         DatabaseArrayType Databases;
<a name="l00146"></a>00146 
<a name="l00147"></a>00147 <span class="keyword">private</span>:
<a name="l00148"></a>00148         <span class="keyword">template</span> &lt;<span class="keyword">class</span> RecordType, <span class="keyword">class</span> FieldType&gt;
<a name="l00149"></a>00149         <span class="keywordtype">void</span> ParseRec(<span class="keyword">const</span> RecordType &amp;rec, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end);
<a name="l00150"></a>00150 
<a name="l00151"></a>00151         <span class="keyword">template</span> &lt;<span class="keyword">class</span> FieldType&gt;
<a name="l00152"></a>00152         <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
<a name="l00153"></a>00153                 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end);
<a name="l00154"></a>00154 
<a name="l00155"></a>00155 <span class="keyword">public</span>:
<a name="l00156"></a>00156         <a class="code" href="classBarry_1_1DatabaseDatabase.html">DatabaseDatabase</a>();
<a name="l00157"></a>00157         ~<a class="code" href="classBarry_1_1DatabaseDatabase.html">DatabaseDatabase</a>();
<a name="l00158"></a>00158 
<a name="l00159"></a>00159         <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &amp;data);
<a name="l00160"></a>00160         <span class="keywordtype">void</span> Clear();
<a name="l00161"></a>00161 
<a name="l00162"></a>00162         <span class="comment">// returns true on success, and fills target</span>
<a name="l00163"></a>00163         <span class="keywordtype">bool</span> GetDBNumber(<span class="keyword">const</span> std::string &amp;name, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;number) <span class="keyword">const</span>;
<a name="l00164"></a>00164         <span class="keywordtype">bool</span> GetDBName(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number, std::string &amp;name) <span class="keyword">const</span>;
<a name="l00165"></a>00165 
<a name="l00166"></a>00166         <span class="keywordtype">void</span> Dump(std::ostream &amp;os) <span class="keyword">const</span>;
<a name="l00167"></a>00167 };
<a name="l00168"></a>00168 
<a name="l00169"></a>00169 BXEXPORT <span class="keyword">inline</span> std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> <a class="code" href="classBarry_1_1DatabaseDatabase.html">DatabaseDatabase</a> &amp;dbdb) {
<a name="l00170"></a>00170         dbdb.Dump(os);
<a name="l00171"></a>00171         <span class="keywordflow">return</span> os;
<a name="l00172"></a>00172 }
<a name="l00173"></a>00173 
<a name="l00174"></a><a class="code" href="structBarry_1_1UnknownData.html">00174</a> <span class="keyword">struct </span><a class="code" href="structBarry_1_1UnknownData.html">UnknownData</a>
<a name="l00175"></a>00175 {
<a name="l00176"></a>00176         std::string raw_data;
<a name="l00177"></a>00177 
<a name="l00178"></a>00178         <span class="keyword">const</span> std::string::value_type* data()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> raw_data.data(); }
<a name="l00179"></a>00179         std::string::size_type size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> raw_data.size(); }
<a name="l00180"></a>00180         <span class="keywordtype">void</span> assign(<span class="keyword">const</span> std::string::value_type *s, std::string::size_type n)
<a name="l00181"></a>00181                 { raw_data.assign(s, n); }
<a name="l00182"></a>00182 };
<a name="l00183"></a>00183 
<a name="l00184"></a><a class="code" href="structBarry_1_1UnknownField.html">00184</a> <span class="keyword">struct </span>BXEXPORT <a class="code" href="structBarry_1_1UnknownField.html">UnknownField</a>
<a name="l00185"></a>00185 {
<a name="l00186"></a>00186         uint8_t type;
<a name="l00187"></a>00187         <a class="code" href="structBarry_1_1UnknownData.html">UnknownData</a> data;
<a name="l00188"></a>00188 };
<a name="l00189"></a>00189 BXEXPORT std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, const std::vector&lt;UnknownField&gt; &amp;unknowns);
<a name="l00190"></a>00190 
<a name="l00191"></a><a class="code" href="structBarry_1_1EmailAddress.html">00191</a> <span class="keyword">struct </span>BXEXPORT <a class="code" href="structBarry_1_1EmailAddress.html">EmailAddress</a>
<a name="l00192"></a>00192 {
<a name="l00193"></a>00193         std::string Name;
<a name="l00194"></a>00194         std::string Email;
<a name="l00195"></a>00195 
<a name="l00196"></a>00196         <span class="keywordtype">void</span> clear()
<a name="l00197"></a>00197         {
<a name="l00198"></a>00198                 Name.clear();
<a name="l00199"></a>00199                 Email.clear();
<a name="l00200"></a>00200         }
<a name="l00201"></a>00201 
<a name="l00202"></a>00202         <span class="keywordtype">size_t</span> size()<span class="keyword"> const</span>
<a name="l00203"></a>00203 <span class="keyword">        </span>{
<a name="l00204"></a>00204                 <span class="keywordflow">return</span> Name.size() + Email.size();
<a name="l00205"></a>00205         }
<a name="l00206"></a>00206 };
<a name="l00207"></a>00207 BXEXPORT std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> <a class="code" href="structBarry_1_1EmailAddress.html">EmailAddress</a> &amp;msga);
<a name="l00208"></a>00208 
<a name="l00209"></a>00209 <span class="keyword">typedef</span> std::vector&lt;EmailAddress&gt;       EmailAddressList;
<a name="l00210"></a>00210 BXEXPORT std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> EmailAddressList &amp;elist);
<a name="l00211"></a>00211 
<a name="l00212"></a><a class="code" href="structBarry_1_1PostalAddress.html">00212</a> <span class="keyword">struct </span>BXEXPORT <a class="code" href="structBarry_1_1PostalAddress.html">PostalAddress</a>
<a name="l00213"></a>00213 {
<a name="l00214"></a>00214         std::string
<a name="l00215"></a>00215                 Address1,
<a name="l00216"></a>00216                 Address2,
<a name="l00217"></a>00217                 Address3,
<a name="l00218"></a>00218                 City,
<a name="l00219"></a>00219                 Province,
<a name="l00220"></a>00220                 PostalCode,
<a name="l00221"></a>00221                 Country;
<a name="l00222"></a>00222 
<a name="l00223"></a>00223         std::string GetLabel() <span class="keyword">const</span>;
<a name="l00224"></a>00224         <span class="keywordtype">void</span> Clear();
<a name="l00225"></a>00225 
<a name="l00226"></a>00226         <span class="keywordtype">bool</span> HasData()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Address1.size() || Address2.size() ||
<a name="l00227"></a>00227                 Address3.size() || City.size() || Province.size() ||
<a name="l00228"></a>00228                 PostalCode.size() || Country.size(); }
<a name="l00229"></a>00229 };
<a name="l00230"></a>00230 BXEXPORT std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> <a class="code" href="structBarry_1_1PostalAddress.html">PostalAddress</a> &amp;msga);
<a name="l00231"></a>00231 
<a name="l00232"></a><a class="code" href="structBarry_1_1Date.html">00232</a> <span class="keyword">struct </span>BXEXPORT <a class="code" href="structBarry_1_1Date.html">Date</a>
<a name="l00233"></a>00233 {
<a name="l00234"></a>00234         <span class="keywordtype">int</span> Month;                      <span class="comment">// 0 to 11</span>
<a name="l00235"></a>00235         <span class="keywordtype">int</span> Day;                        <span class="comment">// 1 to 31</span>
<a name="l00236"></a>00236         <span class="keywordtype">int</span> Year;                       <span class="comment">// exact number, eg. 2008</span>
<a name="l00237"></a>00237 
<a name="l00238"></a>00238         <a class="code" href="structBarry_1_1Date.html">Date</a>() : Month(0), Day(0), Year(0) {}
<a name="l00239"></a>00239         <span class="keyword">explicit</span> <a class="code" href="structBarry_1_1Date.html">Date</a>(<span class="keyword">const</span> <span class="keyword">struct</span> tm *timep);
<a name="l00240"></a>00240 
<a name="l00241"></a>00241         <span class="keywordtype">bool</span> HasData()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Month || Day || Year; }
<a name="l00242"></a>00242         <span class="keywordtype">void</span> Clear();
<a name="l00243"></a>00243 
<a name="l00244"></a>00244         <span class="keywordtype">void</span> ToTm(<span class="keyword">struct</span> tm *timep) <span class="keyword">const</span>;
<a name="l00245"></a>00245         std::string ToYYYYMMDD() <span class="keyword">const</span>;
<a name="l00246"></a>00246         std::string ToBBString() <span class="keyword">const</span>; <span class="comment">// converts to Blackberry string</span>
<a name="l00247"></a>00247                                         <span class="comment">// format of DD/MM/YYYY</span>
<a name="l00248"></a>00248 
<a name="l00249"></a>00249         <span class="keywordtype">bool</span> FromTm(<span class="keyword">const</span> <span class="keyword">struct</span> tm *timep);
<a name="l00250"></a>00250         <span class="keywordtype">bool</span> FromBBString(<span class="keyword">const</span> std::string &amp;str);
<a name="l00251"></a>00251         <span class="keywordtype">bool</span> FromYYYYMMDD(<span class="keyword">const</span> std::string &amp;str);
<a name="l00252"></a>00252 };
<a name="l00253"></a>00253 BXEXPORT std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> <a class="code" href="structBarry_1_1Date.html">Date</a> &amp;date);
<a name="l00254"></a>00254 
<a name="l00255"></a><a class="code" href="classBarry_1_1CategoryList.html">00255</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1CategoryList.html">CategoryList</a> : <span class="keyword">public</span> std::vector&lt;std::string&gt;
<a name="l00256"></a>00256 {
<a name="l00257"></a>00257 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00258"></a>00258 <span class="comment">        /// Parses the given comma delimited category string into</span>
<a name="l00259"></a>00259 <span class="comment">        /// this CategoryList object, appending each token to the vector.</span>
<a name="l00260"></a>00260 <span class="comment">        /// Will clear vector beforehand.</span>
<a name="l00261"></a>00261 <span class="comment"></span>        <span class="keywordtype">void</span> CategoryStr2List(<span class="keyword">const</span> std::string &amp;str);
<a name="l00262"></a>00262 <span class="comment"></span>
<a name="l00263"></a>00263 <span class="comment">        /// Turns the current vectory into a comma delimited category</span>
<a name="l00264"></a>00264 <span class="comment">        /// string suitable for use in Calendar, Task, and Memo</span>
<a name="l00265"></a>00265 <span class="comment">        /// protocol values.</span>
<a name="l00266"></a>00266 <span class="comment"></span>        <span class="keywordtype">void</span> CategoryList2Str(std::string &amp;str) <span class="keyword">const</span>;
<a name="l00267"></a>00267 
<a name="l00268"></a>00268         <span class="keyword">using</span> std::vector&lt;std::string&gt;::operator=;
<a name="l00269"></a>00269 };
<a name="l00270"></a>00270 
<a name="l00271"></a>00271 <span class="comment"></span>
<a name="l00272"></a>00272 <span class="comment">/// \addtogroup RecordParserClasses</span>
<a name="l00273"></a>00273 <span class="comment">///             Parser and data storage classes.  These classes take a</span>
<a name="l00274"></a>00274 <span class="comment">///             Database Database record and convert them into C++ objects.</span>
<a name="l00275"></a>00275 <span class="comment">///             Each of these classes are safe to be used in standard</span>
<a name="l00276"></a>00276 <span class="comment">///             containers, and are meant to be used in conjunction with the</span>
<a name="l00277"></a>00277 <span class="comment">///             RecordParser&lt;&gt; template when calling Controller::LoadDatabase().</span>
<a name="l00278"></a>00278 <span class="comment">/// @{</span>
<a name="l00279"></a>00279 <span class="comment">/// @}</span>
<a name="l00280"></a>00280 <span class="comment"></span>
<a name="l00281"></a>00281 } <span class="comment">// namespace Barry</span>
<a name="l00282"></a>00282 
<a name="l00283"></a>00283 <span class="preprocessor">#ifndef __BARRY_LIBRARY_BUILD__</span>
<a name="l00284"></a>00284 <span class="preprocessor"></span><span class="comment">// Include all parser classes, to make it easy for the application to use.</span>
<a name="l00285"></a>00285 <span class="preprocessor">#include &quot;<a class="code" href="r__calendar_8h.html" title="Blackberry database record parser class for calendar records.">r_calendar.h</a>&quot;</span>
<a name="l00286"></a>00286 <span class="preprocessor">#include &quot;<a class="code" href="r__calllog_8h.html" title="Record parsing class for call logs.">r_calllog.h</a>&quot;</span>
<a name="l00287"></a>00287 <span class="preprocessor">#include &quot;<a class="code" href="r__contact_8h.html" title="Blackberry database record parser class for contact records.">r_contact.h</a>&quot;</span>
<a name="l00288"></a>00288 <span class="preprocessor">#include &quot;<a class="code" href="r__memo_8h.html" title="Record parsing class for the memo database.">r_memo.h</a>&quot;</span>
<a name="l00289"></a>00289 <span class="preprocessor">#include &quot;<a class="code" href="r__message_8h.html" title="Blackberry database record parser class for email records.">r_message.h</a>&quot;</span>
<a name="l00290"></a>00290 <span class="preprocessor">#include &quot;<a class="code" href="r__servicebook_8h.html" title="Blackberry database record parser class for the Service Book record.">r_servicebook.h</a>&quot;</span>
<a name="l00291"></a>00291 <span class="preprocessor">#include &quot;<a class="code" href="r__task_8h.html" title="Record parsing class for the task database.">r_task.h</a>&quot;</span>
<a name="l00292"></a>00292 <span class="preprocessor">#include &quot;<a class="code" href="r__pin__message_8h.html" title="Blackberry database record parser class for pin message records.">r_pin_message.h</a>&quot;</span>
<a name="l00293"></a>00293 <span class="preprocessor">#include &quot;r_saved_message.h&quot;</span>
<a name="l00294"></a>00294 <span class="preprocessor">#include &quot;r_sms.h&quot;</span>
<a name="l00295"></a>00295 <span class="preprocessor">#include &quot;<a class="code" href="r__folder_8h.html" title="Record parsing class for the Folder database.">r_folder.h</a>&quot;</span>
<a name="l00296"></a>00296 <span class="preprocessor">#include &quot;<a class="code" href="r__timezone_8h.html" title="Record parsing class for the timezone database.">r_timezone.h</a>&quot;</span>
<a name="l00297"></a>00297 <span class="preprocessor">#endif</span>
<a name="l00298"></a>00298 <span class="preprocessor"></span>
<a name="l00299"></a>00299 <span class="preprocessor">#endif</span>
<a name="l00300"></a>00300 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by&nbsp;
<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>