<!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: r_recur_base.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>r_recur_base.h</h1><a href="r__recur__base_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 r_recur_base.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Base class for recurring calendar event data.</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_RECORD_RECUR_BASE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_RECORD_RECUR_BASE_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="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <iosfwd></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <vector></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <map></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <stdint.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>Barry {
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// forward declarations</span>
<a name="l00036"></a>00036 <span class="keyword">class </span>IConverter;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment">//</span>
<a name="l00039"></a>00039 <span class="comment">// NOTE: All classes here must be container-safe! Perhaps add sorting</span>
<a name="l00040"></a>00040 <span class="comment">// operators in the future.</span>
<a name="l00041"></a>00041 <span class="comment">//</span>
<a name="l00042"></a>00042
<a name="l00043"></a><a class="code" href="classBarry_1_1RecurBase.html">00043</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1RecurBase.html">RecurBase</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment"> ///</span>
<a name="l00047"></a>00047 <span class="comment"> /// Recurring data</span>
<a name="l00048"></a>00048 <span class="comment"> ///</span>
<a name="l00049"></a>00049 <span class="comment"> /// Note: interval can be used on all of these recurring types to</span>
<a name="l00050"></a>00050 <span class="comment"> /// make it happen "every other time" or more, etc.</span>
<a name="l00051"></a>00051 <span class="comment"> ///</span>
<a name="l00052"></a><a class="code" href="classBarry_1_1RecurBase.html#a3c5b5a4260b70a3919752a5b93841ed0">00052</a> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="classBarry_1_1RecurBase.html#a3c5b5a4260b70a3919752a5b93841ed0" title="Recurring data.">RecurringCodeType</a> {
<a name="l00053"></a>00053 Day = 1, <span class="comment">//< eg. every day</span>
<a name="l00054"></a>00054 <span class="comment">//< set: nothing</span>
<a name="l00055"></a>00055 MonthByDate = 3, <span class="comment">//< eg. every month on the 12th</span>
<a name="l00056"></a>00056 <span class="comment">//< set: DayOfMonth</span>
<a name="l00057"></a>00057 MonthByDay = 4, <span class="comment">//< eg. every month on 3rd Wed</span>
<a name="l00058"></a>00058 <span class="comment">//< set: DayOfWeek and WeekOfMonth</span>
<a name="l00059"></a>00059 YearByDate = 5, <span class="comment">//< eg. every year on March 5</span>
<a name="l00060"></a>00060 <span class="comment">//< set: DayOfMonth and MonthOfYear</span>
<a name="l00061"></a>00061 YearByDay = 6, <span class="comment">//< eg. every year on 3rd Wed of Jan</span>
<a name="l00062"></a>00062 <span class="comment">//< set: DayOfWeek, WeekOfMonth, and</span>
<a name="l00063"></a>00063 <span class="comment">//< MonthOfYear</span>
<a name="l00064"></a>00064 Week = 12 <span class="comment">//< eg. every week on Mon and Fri</span>
<a name="l00065"></a>00065 <span class="comment">//< set: WeekDays</span>
<a name="l00066"></a>00066 };
<a name="l00067"></a>00067
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keywordtype">bool</span> Recurring;
<a name="l00070"></a>00070 RecurringCodeType RecurringType;
<a name="l00071"></a>00071 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> Interval; <span class="comment">// must be >= 1</span>
<a name="l00072"></a>00072 time_t RecurringEndTime; <span class="comment">// only pertains if Recurring is true</span>
<a name="l00073"></a>00073 <span class="comment">// sets the date and time when</span>
<a name="l00074"></a>00074 <span class="comment">// recurrence of this appointment</span>
<a name="l00075"></a>00075 <span class="comment">// should no longer occur</span>
<a name="l00076"></a>00076 <span class="comment">// If a perpetual appointment, this</span>
<a name="l00077"></a>00077 <span class="comment">// is 0xFFFFFFFF in the low level data</span>
<a name="l00078"></a>00078 <span class="comment">// Instead, set the following flag.</span>
<a name="l00079"></a>00079 <span class="keywordtype">bool</span> Perpetual; <span class="comment">// if true, this will always recur</span>
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <span class="comment">// recurring details, depending on type</span>
<a name="l00082"></a>00082 DayOfWeek, <span class="comment">// 0-6</span>
<a name="l00083"></a>00083 WeekOfMonth, <span class="comment">// 1-5</span>
<a name="l00084"></a>00084 DayOfMonth, <span class="comment">// 1-31</span>
<a name="l00085"></a>00085 MonthOfYear; <span class="comment">// 1-12</span>
<a name="l00086"></a>00086 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> WeekDays; <span class="comment">// bitmask, bit 0 = sunday</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="comment">// FIXME - put these somewhere usable by both C and C++</span>
<a name="l00089"></a>00089 <span class="preprocessor"> #define CAL_WD_SUN 0x01</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor"> #define CAL_WD_MON 0x02</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor"> #define CAL_WD_TUE 0x04</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span><span class="preprocessor"> #define CAL_WD_WED 0x08</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="preprocessor"> #define CAL_WD_THU 0x10</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor"> #define CAL_WD_FRI 0x20</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor"> #define CAL_WD_SAT 0x40</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>
<a name="l00097"></a>00097 <span class="keyword">protected</span>:
<a name="l00098"></a>00098 <span class="keywordtype">void</span> ParseRecurrenceData(<span class="keyword">const</span> <span class="keywordtype">void</span> *data);
<a name="l00099"></a>00099 <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> WeekDayProto2Rec(uint8_t raw_field);
<a name="l00100"></a>00100 <span class="keyword">static</span> uint8_t WeekDayRec2Proto(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> weekdays);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">protected</span>:
<a name="l00103"></a>00103 <a class="code" href="classBarry_1_1RecurBase.html">RecurBase</a>();
<a name="l00104"></a>00104 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1RecurBase.html">RecurBase</a>();
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keyword">public</span>:
<a name="l00107"></a>00107 <span class="comment">// return true if parse, false if not (for example, if type not</span>
<a name="l00108"></a>00108 <span class="comment">// recognized)</span>
<a name="l00109"></a>00109 <span class="keywordtype">bool</span> ParseField(uint8_t type, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size,
<a name="l00110"></a>00110 <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="l00111"></a>00111 <span class="keywordtype">void</span> BuildRecurrenceData(time_t StartTime, <span class="keywordtype">void</span> *data) <span class="keyword">const</span>;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 uint8_t RecurringFieldType() <span class="keyword">const</span>;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keywordtype">void</span> Clear();
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00118"></a>00118 };
<a name="l00119"></a>00119
<a name="l00120"></a>00120 BXEXPORT <span class="keyword">inline</span> std::ostream& operator<<(std::ostream &os, <span class="keyword">const</span> RecurBase &msg) {
<a name="l00121"></a>00121 msg.Dump(os);
<a name="l00122"></a>00122 <span class="keywordflow">return</span> os;
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124
<a name="l00125"></a>00125 } <span class="comment">// namespace Barry</span>
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="preprocessor">#endif</span>
<a name="l00128"></a>00128 <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>
