src/DB/Savables/Area.h

00001 /***************************************************************************
00002  *   Copyright (C) 2008 by Sverre Rabbelier                                *
00003  *   sverre@rabbelier.nl                                                   *
00004  *                                                                         *
00005  *   This program is free software; you can redistribute it and/or modify  *
00006  *   it under the terms of the GNU General Public License as published by  *
00007  *   the Free Software Foundation; either version 3 of the License, or     *
00008  *   (at your option) any later version.                                   *
00009  *                                                                         *
00010  *   This program is distributed in the hope that it will be useful,       *
00011  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00012  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
00013  *   GNU General Public License for more details.                          *
00014  *                                                                         *
00015  *   You should have received a copy of the GNU General Public License     *
00016  *   along with this program; if not, write to the                         *
00017  *   Free Software Foundation, Inc.,                                       *
00018  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
00019  ***************************************************************************/
00020 #pragma once
00021 
00022 #include "SavableHeaders.h"
00023 #include "SavableTypes.h"
00024 
00025 namespace mud
00026 {
00027         class AreaManager;
00028         
00029         class Area : public Savable
00030         {
00031         public:
00032                 /*
00033                  * Getters
00034                  */
00035                 value_type getID() const; 
00036                 const std::string& getName() const;
00037                 const std::string& getDescription() const;
00038                 value_type getHeight() const;
00039                 value_type getWidth() const;
00040                 value_type getLength() const;
00041 
00042                 /*
00043                  * Setters
00044                  */
00045                 void setName(const std::string& name);
00046                 void setDescription(const std::string& description);
00047                 void setHeight(value_type height);
00048                 void setWidth(value_type width);
00049                 void setLength(value_type length);
00050 
00051                 /*
00052                  * Utilities
00053                  */
00054                 SavableManagerPtr getManager() const;
00055                 TableImplPtr getTable() const;
00056                 
00057                 /*
00058                  * brief Database operations
00059                  */
00060                 void Delete();
00061                 void Save();
00062                 void Discard();
00063                 bool Exists();
00064 
00065         private:
00066                 friend class mud::AreaManager; // For constructor
00067                 friend SmartPtrDelete(mud::Area);
00068                 
00069                 SavableManagerPtr m_area;
00070 
00075                 Area(SavableManagerPtr area);
00076                 
00077                 Area(const Area& rhs);
00078                 Area operator=(const Area& rhs);
00079                         
00081                 ~Area(void);
00082         };
00083 }

Generated for UnsignedByte by  doxygen 1.5.3
SourceForge.net Logo