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 WareDescriptor.hpp 00034 \brief Header of ... 00035 00036 \author Jean-Christophe FABRE <fabrejc@supagro.inra.fr> 00037 */ 00038 00039 #ifndef __WAREDESCRIPTOR_HPP__ 00040 #define __WAREDESCRIPTOR_HPP__ 00041 00042 #include <openfluid/ware/PluggableWare.hpp> 00043 #include <openfluid/dllexport.hpp> 00044 00045 namespace openfluid { 00046 namespace fluidx { 00047 00048 class DLLEXPORT WareDescriptor 00049 { 00050 public: 00051 00052 enum WareType 00053 { 00054 NoWareType, PluggedSimulator, Generator, PluggedObserver 00055 }; 00056 00057 protected: 00058 00059 WareType m_WareType; 00060 00061 openfluid::ware::WareParams_t m_Params; // Simulator parameters set 00062 00063 bool m_Enabled; 00064 00065 public: 00066 00067 WareDescriptor(); 00068 00069 virtual ~WareDescriptor(); 00070 00071 void setParameter(const openfluid::ware::WareParamKey_t& Key, 00072 const openfluid::ware::WareParamValue_t& Value); 00073 00074 void setParameters(const openfluid::ware::WareParams_t& Params); 00075 00076 openfluid::ware::WareParams_t getParameters(); 00077 00078 bool isType(WareType MIType) const; 00079 00080 WareType getType() const; 00081 00082 void eraseParameter(const openfluid::ware::WareParamKey_t& Key); 00083 00084 void clearParameters(); 00085 00086 bool hasParameter(std::string ParameterKey); 00087 00088 void setEnabled(bool Enabled); 00089 00090 bool isEnabled() const; 00091 00092 }; 00093 00094 } 00095 } // namespaces 00096 00097 #endif /* __WAREDESCRIPTOR_HPP__ */