src/DB/Savables/Area.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Sverre Rabbelier                                *
   3  *   sverre@rabbelier.nl                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 3 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #pragma once
  21
  22 #include "SavableHeaders.h"
  23 #include "SavableTypes.h"
  24
  25 namespace mud
  26 {
  27         class AreaManager;
  28
  29         class Area : public Savable
  30         {
  31         public:
  32                 /*
  33                  * Getters
  34                  */
  35                 value_type getID() const;
  36                 const std::string& getName() const;
  37                 const std::string& getDescription() const;
  38                 value_type getHeight() const;
  39                 value_type getWidth() const;
  40                 value_type getLength() const;
  41
  42                 /*
  43                  * Setters
  44                  */
  45                 void setName(const std::string& name);
  46                 void setDescription(const std::string& description);
  47                 void setHeight(value_type height);
  48                 void setWidth(value_type width);
  49                 void setLength(value_type length);
  50
  51                 /*
  52                  * Utilities
  53                  */
  54                 SavableManagerPtr getManager() const;
  55                 TableImplPtr getTable() const;
  56
  57                 /*
  58                  * brief Database operations
  59                  */
  60                 void Delete();
  61                 void Save();
  62                 void Discard();
  63                 bool Exists();
  64
  65         private:
  66                 friend class mud::AreaManager; // For constructor
  67                 friend SmartPtrDelete(mud::Area);
  68
  69                 SavableManagerPtr m_area;
  70
  71                 /**
  72                  * Constructor
  73                  * @param area The DB object
  74                  */
  75                 Area(SavableManagerPtr area);
  76
  77                 Area(const Area& rhs);
  78                 Area operator=(const Area& rhs);
  79
  80                 /** Destructor, unlocks the savable. */
  81                 ~Area(void);
  82         };
  83 }