src/r_message.h

   1 ///
   2 /// \file       r_message.h
   3 ///             Blackberry database record parser class for email records.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2012, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_RECORD_MESSAGE_H__
  23 #define __BARRY_RECORD_MESSAGE_H__
  24
  25 #include "dll.h"
  26 #include "r_message_base.h"
  27
  28 namespace Barry {
  29
  30 //
  31 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  32 //        operators in the future.
  33 //
  34
  35 /// \addtogroup RecordParserClasses
  36 /// @{
  37
  38 class BXEXPORT Message : public MessageBase
  39 {
  40 public:
  41         Message()
  42         {
  43                 // must call this again, since base class can't call ours
  44                 Clear();
  45         }
  46
  47         void Clear()
  48         {
  49                 MessageBase::Clear();
  50
  51                 RecType = GetDefaultRecType();
  52                 RecordId = 0;
  53         }
  54
  55         // database name
  56         static const char * GetDBName() { return "Messages"; }
  57         static uint8_t GetDefaultRecType() { return 0; }
  58
  59         // Generic Field Handle support
  60         static const FieldHandle<Message>::ListT& GetFieldHandles();
  61 };
  62
  63 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Message &msg) {
  64         msg.Dump(os);
  65         return os;
  66 }
  67
  68 /// @}
  69
  70 } // namespace Barry
  71
  72 #endif
  73