r_memo.h

Go to the documentation of this file.
00001 ///
00002 /// \file       r_memo.h
00003 ///             Record parsing class for the memo database.
00004 ///
00005 
00006 /*
00007     Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
00008     Copyright (C) 2007, Brian Edginton
00009 
00010     This program is free software; you can redistribute it and/or modify
00011     it under the terms of the GNU General Public License as published by
00012     the Free Software Foundation; either version 2 of the License, or
00013     (at your option) any later version.
00014 
00015     This program is distributed in the hope that it will be useful,
00016     but WITHOUT ANY WARRANTY; without even the implied warranty of
00017     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00018 
00019     See the GNU General Public License in the COPYING file at the
00020     root directory of this project for more details.
00021 */
00022 
00023 #ifndef __BARRY_RECORD_MEMO_H__
00024 #define __BARRY_RECORD_MEMO_H__
00025 
00026 #include "dll.h"
00027 #include "record.h"
00028 #include <vector>
00029 #include <string>
00030 #include <stdint.h>
00031 
00032 namespace Barry {
00033 
00034 class BXEXPORT Memo
00035 {
00036 public:
00037         typedef std::vector<UnknownField>       UnknownsType;
00038 
00039         uint8_t RecType;
00040         uint32_t RecordId;
00041 
00042         uint8_t MemoType;
00043         std::string Title;
00044         std::string Body;
00045         std::string Category;
00046 
00047         UnknownsType Unknowns;
00048 
00049 public:
00050         const unsigned char* ParseField(const unsigned char *begin,
00051                 const unsigned char *end);
00052 
00053 public:
00054         Memo();
00055         ~Memo();
00056 
00057         // Parser / Builder API (see parser.h / builder.h)
00058         uint8_t GetRecType() const { return RecType; }
00059         uint32_t GetUniqueId() const { return RecordId; }
00060         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
00061         void ParseHeader(const Data &data, size_t &offset);
00062         void ParseFields(const Data &data, size_t &offset);
00063         void BuildHeader(Data &data, size_t &offset) const;
00064 
00065         void Clear();
00066 
00067         void Dump(std::ostream &os) const;
00068         
00069         bool operator<(const Memo &other) const { return Title < other.Title; }
00070         // database name
00071         static const char * GetDBName() { return "Memos"; }
00072         static uint8_t GetDefaultRecType() { return 0; }    // or 0?
00073 };
00074 
00075 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Memo &msg) {
00076         msg.Dump(os);
00077         return os;
00078 }
00079 
00080 } // namespace Barry
00081 
00082 #endif
00083 

Generated on Wed Sep 24 21:27:32 2008 for Barry by  doxygen 1.5.1