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 AdvancedDatastoreDescriptor.hpp 00034 \brief Header of ... 00035 00036 \author Aline LIBRES <aline.libres@gmail.com> 00037 */ 00038 00039 #ifndef __ADVANCEDDATASTOREDESCRIPTOR_HPP__ 00040 #define __ADVANCEDDATASTOREDESCRIPTOR_HPP__ 00041 00042 #include <list> 00043 #include <string> 00044 #include <openfluid/dllexport.hpp> 00045 00046 #include <openfluid/core/UnstructuredValue.hpp> 00047 00048 00049 namespace openfluid { namespace fluidx { 00050 00051 class DatastoreDescriptor; 00052 class DatastoreItemDescriptor; 00053 00054 class DLLEXPORT AdvancedDatastoreDescriptor 00055 { 00056 private: 00057 00058 openfluid::fluidx::DatastoreDescriptor* mp_DatastoreDesc; 00059 00060 public: 00061 00062 AdvancedDatastoreDescriptor( 00063 openfluid::fluidx::DatastoreDescriptor& DatastoreDesc); 00064 00065 ~AdvancedDatastoreDescriptor(); 00066 00067 const std::list<openfluid::fluidx::DatastoreItemDescriptor*>& getItems() const; 00068 00069 std::list<openfluid::fluidx::DatastoreItemDescriptor*> getItems(const std::string& UnitClass) const; 00070 00071 std::list<openfluid::fluidx::DatastoreItemDescriptor*> getItems(const std::string& UnitClass, 00072 openfluid::core::UnstructuredValue::UnstructuredType Type) const; 00073 00074 /** 00075 * Move the Item located at the given From position to the To position (positions starts at index 0) 00076 * @param From 00077 * @param To 00078 * @throw openfluid::base::OFException a position is out of range 00079 */ 00080 void moveItem(unsigned int From, unsigned int To); 00081 00082 void appendItem(openfluid::fluidx::DatastoreItemDescriptor* Item); 00083 00084 /** 00085 Insert an Item before the given position (positions starts at index 0) 00086 @param[in] Item the DatastoreItemDescriptor to insert 00087 @param[in] Position the position, should be between zero and list size - 1. 00088 To insert an Item at the end of the list, use appendItem instead. 00089 @throw openfluid::base::OFException if Position is out of range 00090 */ 00091 void insertItem(openfluid::fluidx::DatastoreItemDescriptor* Item, 00092 unsigned int Position); 00093 00094 /** 00095 Remove from the list the Item located at the given Position (positions starts at index 0). 00096 This doesn't delete the DatastoreItemDescriptor pointer. 00097 @param[in] Position the position 00098 @throw openfluid::base::OFException if Position is out of range 00099 */ 00100 void removeItem(unsigned int Position); 00101 00102 std::list<std::string> getItemsIDs() const; 00103 00104 bool isItemAlreadyExist(std::string ItemID) const; 00105 00106 /** 00107 * @brief Gets the item of the datastore matching the given ID. 00108 * 00109 * @param ItemID ID of the expected item. 00110 * @return The item with the given ID, or 0 if not found. 00111 */ 00112 openfluid::fluidx::DatastoreItemDescriptor* getItem(const std::string& ItemID); 00113 00114 00115 00116 }; 00117 00118 } } // namespaces 00119 00120 #endif /* __ADVANCEDDATASTOREDESCRIPTOR_HPP__ */