src/r_pin_message.h

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