src/DB/Savables/Room.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 Room : public Savable
  28         {
  29         public:
  30                 /*
  31                  * Getters
  32                  */
  33                 value_type getID() const;
  34                 const std::string& getName() const;
  35                 const std::string& getDescription() const;
  36                 value_type getSector() const;
  37                 value_type getCluster() 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 setSector(value_type sector);
  48                 void setCluster(value_type cluster);
  49                 void setHeight(value_type height);
  50                 void setWidth(value_type width);
  51                 void setLength(value_type length);
  52
  53                 /*
  54                  * Utilities
  55                  */
  56                 SavableManagerPtr getManager() const;
  57                 TableImplPtr getTable() const;
  58                 std::string toString() const;
  59                 std::string toFullString() const;
  60
  61                 /*
  62                  * Database utilities
  63                  */
  64                 void Delete();
  65                 void Save();
  66                 void Delete(value_type accountid, const std::string& description);
  67                 void Save(value_type accountid, const std::string& description);
  68                 void Discard();
  69                 bool Exists();
  70
  71         private:
  72                 SavableManagerPtr m_room;
  73
  74                 Room(SavableManagerPtr room);
  75                 Room(const Room& rhs);
  76                 Room operator=(const Room& rhs);
  77                 ~Room(void);
  78
  79                 friend class RoomManager; // constructor
  80                 friend SmartPtrDelete(mud::Room);
  81         };
  82 }