src/DB/Savables/Sector.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 SectorManager;
  28
  29         class Sector : public Savable
  30         {
  31         public:
  32                 /*
  33                  * Getters
  34                  */
  35                 value_type getID() const;
  36                 const std::string& getName() const;
  37                 const std::string& getSymbol() const;
  38                 long getMoveCost() const;
  39                 bool isWater() const;
  40
  41                 /*
  42                  * Setters
  43                  */
  44                 void setName(const std::string& name);
  45                 void setSymbol(const std::string& symbol);
  46                 void setMoveCost(long movecost);
  47                 void setWater(bool water);
  48
  49                 /*
  50                  * Utilities
  51                  */
  52                 SavableManagerPtr getManager() const;
  53                 TableImplPtr getTable() const;
  54
  55                 /*
  56                  * Database utilities
  57                  */
  58                 void Delete();
  59                 void Save();
  60                 void Discard();
  61                 bool Exists();
  62
  63         private:
  64                 SavableManagerPtr m_sector;
  65
  66                 /*
  67                  * Ctors
  68                  */
  69                 Sector(SavableManagerPtr Sector);
  70                 Sector(const Sector& rhs);
  71                 Sector operator=(const Sector& rhs);
  72                 ~Sector(void);
  73
  74                 friend class SectorManager;
  75                 friend SmartPtrDelete(mud::Sector);
  76         };
  77 }