00001 /* 00002 00003 This file is part of OpenFLUID software 00004 Copyright(c) 2007, INRA - Montpellier SupAgro 00005 00006 00007 == GNU General Public License Usage == 00008 00009 OpenFLUID is free software: you can redistribute it and/or modify 00010 it under the terms of the GNU General Public License as published by 00011 the Free Software Foundation, either version 3 of the License, or 00012 (at your option) any later version. 00013 00014 OpenFLUID is distributed in the hope that it will be useful, 00015 but WITHOUT ANY WARRANTY; without even the implied warranty of 00016 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00017 GNU General Public License for more details. 00018 00019 You should have received a copy of the GNU General Public License 00020 along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>. 00021 00022 00023 == Other Usage == 00024 00025 Other Usage means a use of OpenFLUID that is inconsistent with the GPL 00026 license, and requires a written agreement between You and INRA. 00027 Licensees for Other Usage of OpenFLUID may use this file in accordance 00028 with the terms contained in the written agreement between You and INRA. 00029 00030 */ 00031 00032 /** 00033 \file Datastore.hpp 00034 \brief Header of ... 00035 00036 \author Aline LIBRES <libres@supagro.inra.fr> 00037 */ 00038 00039 #ifndef __DATASTORE_HPP__ 00040 #define __DATASTORE_HPP__ 00041 00042 #include <map> 00043 #include <string> 00044 #include <openfluid/dllexport.hpp> 00045 00046 namespace openfluid { namespace core { 00047 00048 class DatastoreItem; 00049 00050 /** 00051 * @brief Container class for holding information about additional resources 00052 * relating to a project. 00053 */ 00054 class DLLEXPORT Datastore 00055 { 00056 public: 00057 00058 /** 00059 * @brief Map indexing DatastoreItems by ID. 00060 */ 00061 typedef std::map<std::string, DatastoreItem*> DataItemsById_t; 00062 00063 private: 00064 00065 DataItemsById_t m_ItemsById; 00066 00067 public: 00068 00069 /** 00070 * @brief Creates an empty datastore. 00071 */ 00072 Datastore(); 00073 00074 /** 00075 * @brief Destroys all items of the datastore. 00076 */ 00077 ~Datastore(); 00078 00079 /** 00080 * @brief Gets all items of the datastore. 00081 * 00082 * @return A map of all items of the datastore. 00083 */ 00084 DataItemsById_t getItems(); 00085 00086 /** 00087 * @brief Gets all items of the datastore. 00088 * 00089 * @return A const map of all items of the datastore. 00090 */ 00091 const DataItemsById_t getItems() const; 00092 00093 /** 00094 * @brief Gets the item of the datastore matching the given ID. 00095 * 00096 * @param ItemID ID of the expected item. 00097 * @return The item with the given ID, or 0 if not found. 00098 */ 00099 DatastoreItem* getItem(const std::string& ItemID); 00100 00101 /** 00102 * @brief Adds an item to the datastore. 00103 * 00104 * If an item already exists with the ID of the given <tt>Item</tt>, 00105 * it is deleted before adding. 00106 * 00107 * @param Item The item to add. 00108 */ 00109 void addItem(const DatastoreItem* Item); 00110 }; 00111 00112 } } // namespaces 00113 00114 #endif /* __DATASTORE_HPP__ */