src/DB/Savables/Chunk.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 ChunkManager;
00028         
00029         class Chunk : 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                 const std::string& getTags() const;
00039                 value_type getRoom() const;
00040 
00041                 /*
00042                  * Setters
00043                  */
00044                 void setName(const std::string& name);
00045                 void setDescription(const std::string& description);
00046                 void setTags(const std::string& tags);
00047                 void setRoom(value_type room);
00048 
00049                 /*
00050                  * Utilities
00051                  */
00052                 SavableManagerPtr getManager() const;
00053                 TableImplPtr getTable() const;
00054                 
00055                 /*
00056                  * Database operations
00057                  */
00058                 void Delete();
00059                 void Save();
00060                 void Discard();
00061                 bool Exists();
00062 
00063         private:
00064                 friend class mud::ChunkManager; // For constructor
00065                 friend SmartPtrDelete(mud::Chunk);
00066                 
00067                 SavableManagerPtr m_chunk;
00068 
00073                 Chunk(SavableManagerPtr chunk);
00074                 
00075                 Chunk(const Chunk& rhs);
00076                 Chunk operator=(const Chunk& rhs);
00077                         
00079                 ~Chunk(void);
00080         };
00081 }

Generated for UnsignedByte by  doxygen 1.5.3
SourceForge.net Logo