src/DB/Savables/Cluster.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 ClusterManager;
00028         
00029         class Cluster : 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 getArea() const;
00039 
00040                 /*
00041                  * Setters
00042                  */
00043                 void setName(const std::string& name);
00044                 void setDescription(const std::string& description);
00045                 void setArea(value_type area);
00046 
00047                 /*
00048                  * Utilities
00049                  */
00050                 SavableManagerPtr getManager() const;
00051                 TableImplPtr getTable() const;
00052                 
00053                 /*
00054                  * brief Database operations
00055                  */
00056                 void Delete();
00057                 void Save();
00058                 void Discard();
00059                 bool Exists();
00060 
00061         private:
00062                 friend class mud::ClusterManager; // For constructor
00063                 friend SmartPtrDelete(mud::Cluster);
00064                 
00065                 SavableManagerPtr m_cluster;
00066 
00071                 Cluster(SavableManagerPtr cluster);
00072                 
00073                 Cluster(const Cluster& rhs);
00074                 Cluster operator=(const Cluster& rhs);
00075                         
00077                 ~Cluster(void);
00078         };
00079 }

Generated for UnsignedByte by  doxygen 1.5.3
SourceForge.net Logo