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 00034 /** 00035 @file 00036 00037 @author Jean-Christophe FABRE <fabrejc@supagro.inra.fr> 00038 */ 00039 00040 00041 #ifndef __ENVPROPERTIES_HPP__ 00042 #define __ENVPROPERTIES_HPP__ 00043 00044 #include <openfluid/dllexport.hpp> 00045 #include <map> 00046 #include <string> 00047 00048 namespace openfluid { namespace base { 00049 00050 /** 00051 Class containing execution environment information for funtions 00052 */ 00053 class DLLEXPORT EnvironmentProperties 00054 { 00055 private: 00056 00057 typedef std::map<std::string,bool> KeyBoolMap_t; 00058 typedef std::map<std::string,std::string> KeyStringMap_t; 00059 00060 KeyBoolMap_t m_BoolValues; 00061 KeyStringMap_t m_StringValues; 00062 00063 public: 00064 00065 /** 00066 Constructor 00067 */ 00068 EnvironmentProperties(); 00069 00070 /** 00071 Destructor 00072 */ 00073 virtual ~EnvironmentProperties(); 00074 00075 /** 00076 Assigns a boolean value to the corresponding key 00077 00078 @return true if the assignment is correct 00079 */ 00080 bool setValue(std::string Key, const bool Value); 00081 00082 /** 00083 Assigns a string value to the corresponding key 00084 00085 @return true if the assignment is correct 00086 */ 00087 bool setValue(std::string Key, const std::string& Value); 00088 00089 /** 00090 Gets the boolean value assigned to the key 00091 00092 @return true if the value exists as a boolean 00093 */ 00094 bool getValue(std::string Key, bool& Value) const; 00095 00096 /** 00097 Gets the string value assigned to the key 00098 00099 @return true if the value exists as a string 00100 */ 00101 bool getValue(std::string Key, std::string& Value) const; 00102 00103 00104 }; 00105 00106 00107 } } // namespaces 00108 00109 #endif /* __ENVPROPERTIES_HPP__ */