<!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: builder.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>builder.h</h1><a href="builder_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 builder.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Virtual protocol packet builder wrapper</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_BUILDER_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_BUILDER_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
<a name="l00027"></a>00027 <span class="keyword">namespace </span>Barry {
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">// forward declarations</span>
<a name="l00030"></a>00030 <span class="keyword">class </span>IConverter;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">//</span>
<a name="l00033"></a>00033 <span class="comment">// Builder class</span>
<a name="l00034"></a>00034 <span class="comment">//</span><span class="comment"></span>
<a name="l00035"></a>00035 <span class="comment">/// Base class for the builder functor hierarchy.</span>
<a name="l00036"></a>00036 <span class="comment">///</span>
<a name="l00037"></a>00037 <span class="comment">/// This defines the API used by the Controller and Packet classes</span>
<a name="l00038"></a>00038 <span class="comment">/// for building a raw device record to write to the device.</span>
<a name="l00039"></a>00039 <span class="comment">///</span>
<a name="l00040"></a><a class="code" href="classBarry_1_1Builder.html">00040</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">public</span>:
<a name="l00043"></a>00043 <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a>() {}
<a name="l00044"></a>00044 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a>() {}
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment"> /// Called first in the sequence, to allow the application to</span>
<a name="l00047"></a>00047 <span class="comment"> /// load the needed data from memory, disk, etc. If successful,</span>
<a name="l00048"></a>00048 <span class="comment"> /// return true. If at the end of the series, return false.</span>
<a name="l00049"></a>00049 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Retrieve(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> databaseId) = 0;
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /// Called to retrive the unique ID for this record.</span>
<a name="l00052"></a>00052 <span class="comment"></span> <span class="keyword">virtual</span> uint8_t GetRecType() <span class="keyword">const</span> = 0;
<a name="l00053"></a>00053 <span class="keyword">virtual</span> uint32_t GetUniqueId() <span class="keyword">const</span> = 0;
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> /// Called before BuildFields() in order to build the header</span>
<a name="l00056"></a>00056 <span class="comment"> /// for this record. Store the raw data in data, at the</span>
<a name="l00057"></a>00057 <span class="comment"> /// offset given in offset. When finished, update offset to</span>
<a name="l00058"></a>00058 <span class="comment"> /// point to the next spot to put new data.</span>
<a name="l00059"></a>00059 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> BuildHeader(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &offset) = 0;
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment"> /// Called to build the record field data. Store the raw data</span>
<a name="l00062"></a>00062 <span class="comment"> /// in data, using offset to know where to write. Be sure to</span>
<a name="l00063"></a>00063 <span class="comment"> /// update offset, and be sure to adjust the size of the data</span>
<a name="l00064"></a>00064 <span class="comment"> /// packet (possibly with Data::ReleaseBuffer()).</span>
<a name="l00065"></a>00065 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> BuildFields(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &offset,
<a name="l00066"></a>00066 <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) = 0;
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">//</span>
<a name="l00071"></a>00071 <span class="comment">// RecordBuilder template class</span>
<a name="l00072"></a>00072 <span class="comment">//</span><span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment">/// Template class for easy creation of specific protocol packet builder</span>
<a name="l00074"></a>00074 <span class="comment">/// objects. This template takes the following template arguments:</span>
<a name="l00075"></a>00075 <span class="comment">///</span>
<a name="l00076"></a>00076 <span class="comment">/// - RecordT: One of the record classes in record.h</span>
<a name="l00077"></a>00077 <span class="comment">/// - StorageT: A custom storage functor class. An object of this type</span>
<a name="l00078"></a>00078 <span class="comment">/// will be called as a function with empty Record as an</span>
<a name="l00079"></a>00079 <span class="comment">/// argument. The storage class is expected to fill the</span>
<a name="l00080"></a>00080 <span class="comment">/// record object in preparation for building the packet</span>
<a name="l00081"></a>00081 <span class="comment">/// out of that data. These calls happen on the fly as the data</span>
<a name="l00082"></a>00082 <span class="comment">/// is sent to the device over USB, so it should not block forever.</span>
<a name="l00083"></a>00083 <span class="comment">///</span>
<a name="l00084"></a>00084 <span class="comment">/// Example SaveDatabase() call:</span>
<a name="l00085"></a>00085 <span class="comment">///</span>
<a name="l00086"></a>00086 <span class="comment">/// <pre></span>
<a name="l00087"></a>00087 <span class="comment">/// FIXME</span>
<a name="l00088"></a>00088 <span class="comment">/// </pre></span>
<a name="l00089"></a>00089 <span class="comment">///</span>
<a name="l00090"></a>00090 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> RecordT, <span class="keyword">class</span> StorageT>
<a name="l00091"></a><a class="code" href="classBarry_1_1RecordBuilder.html">00091</a> <span class="keyword">class </span><a class="code" href="classBarry_1_1RecordBuilder.html" title="Template class for easy creation of specific protocol packet builder objects.">RecordBuilder</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a>
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 StorageT *m_storage;
<a name="l00094"></a>00094 <span class="keywordtype">bool</span> m_owned;
<a name="l00095"></a>00095 RecordT m_rec;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment"> /// Constructor that references an externally managed storage object.</span>
<a name="l00099"></a><a class="code" href="classBarry_1_1RecordBuilder.html#ac8cda12de94498b715d6171fb51930af">00099</a> <span class="comment"></span> <a class="code" href="classBarry_1_1RecordBuilder.html#ac8cda12de94498b715d6171fb51930af" title="Constructor that references an externally managed storage object.">RecordBuilder</a>(StorageT &storage)
<a name="l00100"></a>00100 : m_storage(&storage), m_owned(false) {}
<a name="l00101"></a>00101 <span class="comment"></span>
<a name="l00102"></a>00102 <span class="comment"> /// Constructor that references a locally managed storage object.</span>
<a name="l00103"></a>00103 <span class="comment"> /// The pointer passed in will be stored, and freed when this class</span>
<a name="l00104"></a>00104 <span class="comment"> /// is destroyed. It is safe to call this constructor with</span>
<a name="l00105"></a>00105 <span class="comment"> /// a 'new'ly created storage object.</span>
<a name="l00106"></a><a class="code" href="classBarry_1_1RecordBuilder.html#aab6421e54af5c0886d2d9979fe4d2d35">00106</a> <span class="comment"></span> <a class="code" href="classBarry_1_1RecordBuilder.html#ac8cda12de94498b715d6171fb51930af" title="Constructor that references an externally managed storage object.">RecordBuilder</a>(StorageT *storage)
<a name="l00107"></a>00107 : m_storage(storage), m_owned(true) {}
<a name="l00108"></a>00108
<a name="l00109"></a>00109 ~<a class="code" href="classBarry_1_1RecordBuilder.html" title="Template class for easy creation of specific protocol packet builder objects.">RecordBuilder</a>()
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111 <span class="keywordflow">if</span>( this->m_owned )
<a name="l00112"></a>00112 <span class="keyword">delete</span> m_storage;
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114
<a name="l00115"></a><a class="code" href="classBarry_1_1RecordBuilder.html#a8ce2a42e0805c1b64c6bda3aadeb040e">00115</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1RecordBuilder.html#a8ce2a42e0805c1b64c6bda3aadeb040e" title="Called first in the sequence, to allow the application to load the needed data from...">Retrieve</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> databaseId)
<a name="l00116"></a>00116 {
<a name="l00117"></a>00117 <span class="keywordflow">return</span> (*m_storage)(m_rec, databaseId);
<a name="l00118"></a>00118 }
<a name="l00119"></a>00119
<a name="l00120"></a><a class="code" href="classBarry_1_1RecordBuilder.html#a13dba30bb979be690b85ade4ce79cd7a">00120</a> <span class="keyword">virtual</span> uint8_t <a class="code" href="classBarry_1_1RecordBuilder.html#a13dba30bb979be690b85ade4ce79cd7a" title="Called to retrive the unique ID for this record.">GetRecType</a>()<span class="keyword"> const</span>
<a name="l00121"></a>00121 <span class="keyword"> </span>{
<a name="l00122"></a>00122 <span class="keywordflow">return</span> m_rec.GetRecType();
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="keyword">virtual</span> uint32_t GetUniqueId()<span class="keyword"> const</span>
<a name="l00126"></a>00126 <span class="keyword"> </span>{
<a name="l00127"></a>00127 <span class="keywordflow">return</span> m_rec.GetUniqueId();
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129 <span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment"> /// Functor member called by Controller::SaveDatabase() during</span>
<a name="l00131"></a>00131 <span class="comment"> /// processing.</span>
<a name="l00132"></a><a class="code" href="classBarry_1_1RecordBuilder.html#ab12fe31225a41f2ebcca45dd4d4ce373">00132</a> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1RecordBuilder.html#ab12fe31225a41f2ebcca45dd4d4ce373" title="Functor member called by Controller::SaveDatabase() during processing.">BuildHeader</a>(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &offset)
<a name="l00133"></a>00133 {
<a name="l00134"></a>00134 m_rec.BuildHeader(data, offset);
<a name="l00135"></a>00135 }
<a name="l00136"></a>00136
<a name="l00137"></a><a class="code" href="classBarry_1_1RecordBuilder.html#ad95441f87e80998803d1bb8cfc443c5c">00137</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1RecordBuilder.html#ad95441f87e80998803d1bb8cfc443c5c" title="Called to build the record field data.">BuildFields</a>(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &offset, <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="l00138"></a>00138 {
<a name="l00139"></a>00139 m_rec.BuildFields(data, offset, ic);
<a name="l00140"></a>00140 }
<a name="l00141"></a>00141 };
<a name="l00142"></a>00142
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="comment">//</span>
<a name="l00145"></a>00145 <span class="comment">// RecordFetch template class</span>
<a name="l00146"></a>00146 <span class="comment">//</span><span class="comment"></span>
<a name="l00147"></a>00147 <span class="comment">/// Generic record fetch class, to help with using records without</span>
<a name="l00148"></a>00148 <span class="comment">/// builder classes.</span>
<a name="l00149"></a>00149 <span class="comment">///</span>
<a name="l00150"></a>00150 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> RecordT>
<a name="l00151"></a><a class="code" href="classBarry_1_1RecordFetch.html">00151</a> <span class="keyword">class </span><a class="code" href="classBarry_1_1RecordFetch.html" title="Generic record fetch class, to help with using records without builder classes.">RecordFetch</a>
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 <span class="keyword">const</span> RecordT &m_rec;
<a name="l00154"></a>00154 <span class="keyword">mutable</span> <span class="keywordtype">bool</span> m_done;
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="keyword">public</span>:
<a name="l00157"></a>00157 <a class="code" href="classBarry_1_1RecordFetch.html" title="Generic record fetch class, to help with using records without builder classes.">RecordFetch</a>(<span class="keyword">const</span> RecordT &rec) : m_rec(rec), m_done(<span class="keyword">false</span>) {}
<a name="l00158"></a>00158 <span class="keywordtype">bool</span> operator()(RecordT &rec, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId)<span class="keyword"> const</span>
<a name="l00159"></a>00159 <span class="keyword"> </span>{
<a name="l00160"></a>00160 <span class="keywordflow">if</span>( m_done )
<a name="l00161"></a>00161 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00162"></a>00162 rec = m_rec;
<a name="l00163"></a>00163 m_done = <span class="keyword">true</span>;
<a name="l00164"></a>00164 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00165"></a>00165 }
<a name="l00166"></a>00166 };
<a name="l00167"></a>00167
<a name="l00168"></a>00168
<a name="l00169"></a>00169 } <span class="comment">// namespace Barry</span>
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="preprocessor">#endif</span>
<a name="l00172"></a>00172 <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>
