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 DatastoreItem.hpp 00034 \brief Header of ... 00035 00036 \author Aline LIBRES <libres@supagro.inra.fr> 00037 */ 00038 00039 #ifndef __DATASTOREITEM_HPP__ 00040 #define __DATASTOREITEM_HPP__ 00041 00042 #include <openfluid/dllexport.hpp> 00043 00044 #include <string> 00045 00046 #include <openfluid/core/UnstructuredValue.hpp> 00047 00048 namespace openfluid { 00049 namespace core { 00050 00051 /** 00052 * @brief Item of a Datastore, giving information about an additional resource. 00053 */ 00054 class DLLEXPORT DatastoreItem 00055 { 00056 private: 00057 00058 std::string m_ID; 00059 00060 std::string m_PrefixPath; 00061 00062 std::string m_RelativePath; 00063 00064 std::string m_UnitClass; 00065 00066 UnstructuredValue* m_Value; 00067 00068 public: 00069 00070 /** 00071 * @brief Creates a new resource item. 00072 * 00073 * Tries to create a new resource item and its associated UnstructuredValue, 00074 * depending on the given type. 00075 * 00076 * @param Id The ID of the item. 00077 * @param PrefixPath The prefix path of the item, usually the IN directory of the project. 00078 * @param RelativePath The relative path of the item from the PrefixPath 00079 * @param Type The type of the item. 00080 * @param UnitClass (optional) The associated unit class of the item. 00081 * @throw openfluid::base::OFException if the given type is unknown. 00082 */ 00083 DatastoreItem(std::string ID, std::string PrefixPath, std::string RelativePath, 00084 UnstructuredValue::UnstructuredType Type, std::string UnitClass = ""); 00085 00086 /** 00087 * @brief Destroys the resource and its associated value. 00088 */ 00089 ~DatastoreItem(); 00090 00091 std::string getID() const; 00092 00093 /** 00094 * @brief Returns the prefix path of the resource 00095 */ 00096 std::string getPrefixPath() const; 00097 00098 /** 00099 * @brief Returns the path of the resource, relative to prefix path. 00100 */ 00101 std::string getRelativePath() const; 00102 00103 std::string getUnitClass() const; 00104 00105 /** 00106 * @brief Gets the associated value of the resource. 00107 */ 00108 UnstructuredValue* getValue(); 00109 00110 /** 00111 * @brief Gets the associated value of the resource. 00112 */ 00113 const UnstructuredValue* getValue() const; 00114 }; 00115 00116 } 00117 } // namespaces 00118 00119 #endif /* __DATASTOREITEM_HPP__ */