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 AdvancedMonitoringDescriptor.hpp 00034 \brief Header of ... 00035 00036 \author Aline LIBRES <aline.libres@gmail.com> 00037 */ 00038 00039 #ifndef ADVANCEDMONITORINGDESCRIPTOR_HPP_ 00040 #define ADVANCEDMONITORINGDESCRIPTOR_HPP_ 00041 00042 #include <openfluid/fluidx/MonitoringDescriptor.hpp> 00043 #include <openfluid/dllexport.hpp> 00044 00045 00046 namespace openfluid { 00047 namespace fluidx { 00048 00049 00050 // TODO refactor this for enable the possibility to have the same observer twice in the monitoring list 00051 class DLLEXPORT AdvancedMonitoringDescriptor 00052 { 00053 private: 00054 00055 openfluid::fluidx::MonitoringDescriptor* mp_MonitoringDesc; 00056 00057 public: 00058 00059 AdvancedMonitoringDescriptor( 00060 openfluid::fluidx::MonitoringDescriptor& MonitoringDesc); 00061 00062 ~AdvancedMonitoringDescriptor(); 00063 00064 void checkMonitoring() const; 00065 00066 const std::list<openfluid::fluidx::ObserverDescriptor*>& getItems() const; 00067 00068 /** 00069 * @brief Returns the Descriptor of the Observer with ObserverID if is in the Monitoring descriptor 00070 * @throw openfluid::base::OFException if this Observer is not in the Monitoring descriptor 00071 */ 00072 openfluid::fluidx::ObserverDescriptor& getDescriptor( 00073 std::string ObserverID) const; 00074 00075 /** 00076 * @brief Adds the Observer with ObserverID to the Monitoring descriptor 00077 */ 00078 void addToObserverList(std::string ObserverID); 00079 00080 /** 00081 * @brief Removes the Observer with ObserverID from the Monitoring descriptor 00082 * @throw openfluid::base::OFException if this Observer is not in the Monitoring descriptor 00083 */ 00084 void removeFromObserverList(std::string ObserverID); 00085 00086 /** 00087 * @brief Replace existing observers with ObserversList 00088 */ 00089 void setItems( 00090 std::list<openfluid::fluidx::ObserverDescriptor*> ObserversList); 00091 00092 // TODO to rename to match equivalent in AdvancedModelDescriptor 00093 void moveItemTowardsTheBeginning(std::string ObserverID); 00094 00095 // TODO to rename to match equivalent in AdvancedModelDescriptor 00096 void moveItemTowardsTheEnd(std::string ObserverID); 00097 00098 int getFirstIndex(const std::string& ID) const; 00099 00100 std::vector<openfluid::ware::WareID_t> getOrderedIDs() const; 00101 00102 00103 00104 }; 00105 00106 } 00107 } //namespaces 00108 #endif /* ADVANCEDMONITORINGDESCRIPTOR_HPP_ */