00001 /* 00002 This file is part of OpenFLUID software 00003 Copyright (c) 2007-2010 INRA-Montpellier SupAgro 00004 00005 00006 == GNU General Public License Usage == 00007 00008 OpenFLUID is free software: you can redistribute it and/or modify 00009 it under the terms of the GNU General Public License as published by 00010 the Free Software Foundation, either version 3 of the License, or 00011 (at your option) any later version. 00012 00013 OpenFLUID is distributed in the hope that it will be useful, 00014 but WITHOUT ANY WARRANTY; without even the implied warranty of 00015 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00016 GNU General Public License for more details. 00017 00018 You should have received a copy of the GNU General Public License 00019 along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>. 00020 00021 In addition, as a special exception, INRA gives You the additional right 00022 to dynamically link the code of OpenFLUID with code not covered 00023 under the GNU General Public License ("Non-GPL Code") and to distribute 00024 linked combinations including the two, subject to the limitations in this 00025 paragraph. Non-GPL Code permitted under this exception must only link to 00026 the code of OpenFLUID dynamically through the OpenFLUID libraries 00027 interfaces, and only for building OpenFLUID plugins. The files of 00028 Non-GPL Code may be link to the OpenFLUID libraries without causing the 00029 resulting work to be covered by the GNU General Public License. You must 00030 obey the GNU General Public License in all respects for all of the 00031 OpenFLUID code and other code used in conjunction with OpenFLUID 00032 except the Non-GPL Code covered by this exception. If you modify 00033 this OpenFLUID, you may extend this exception to your version of the file, 00034 but you are not obligated to do so. If you do not wish to provide this 00035 exception without modification, you must delete this exception statement 00036 from your version and license this OpenFLUID solely under the GPL without 00037 exception. 00038 00039 00040 == Other Usage == 00041 00042 Other Usage means a use of OpenFLUID that is inconsistent with the GPL 00043 license, and requires a written agreement between You and INRA. 00044 Licensees for Other Usage of OpenFLUID may use this file in accordance 00045 with the terms contained in the written agreement between You and INRA. 00046 */ 00047 00057 #ifndef __UNIT_H__ 00058 #define __UNIT_H__ 00059 00060 00061 #include <map> 00062 #include <string> 00063 00064 #include <openfluid/core/UnitsColl.hpp> 00065 #include <openfluid/core/InputData.hpp> 00066 #include <openfluid/core/Variables.hpp> 00067 #include <openfluid/core/EventsColl.hpp> 00068 #include <openfluid/dllexport.hpp> 00069 00070 00071 namespace openfluid { namespace core { 00072 00073 class DLLEXPORT UnitsCollection; 00074 00075 00076 00080 typedef std::map<UnitClass_t,UnitsCollection> UnitsListByClassMap_t; 00081 00082 class DLLEXPORT Unit; 00083 00087 typedef std::list<Unit*> UnitsPtrList_t; 00088 00092 typedef std::map<UnitClass_t,UnitsPtrList_t> LinkedUnitsListByClassMap_t; 00093 00122 class DLLEXPORT Unit 00123 { 00124 public: 00125 enum InstanciationType { DESCRIPTOR, SIMULATION, UNKNOWN }; 00126 00127 private: 00128 UnitID_t m_ID; 00129 UnitClass_t m_Class; 00130 unsigned int m_PcsOrder; 00131 00132 LinkedUnitsListByClassMap_t m_FromUnits; 00133 LinkedUnitsListByClassMap_t m_ToUnits; 00134 LinkedUnitsListByClassMap_t m_ParentUnits; 00135 LinkedUnitsListByClassMap_t m_ChildrenUnits; 00136 00137 InputData<InputDataValue> m_InputData; 00138 00139 Variables<ScalarValue> m_ScalarVariables; 00140 Variables<VectorValue> m_VectorVariables; 00141 00142 EventsCollection m_Events; 00143 00144 InstanciationType m_InstType; 00145 00146 public: 00147 00148 /* 00149 Constructor 00150 @param[in] aClass the class of the unit 00151 @param[in] anID the ID of the unit 00152 @param[in] aPcsOrder the process order of the unit 00153 */ 00154 Unit(const UnitClass_t aClass, const UnitID_t anID, 00155 const PcsOrd_t aPcsOrder, const InstanciationType InstType); 00156 00157 /* 00158 Destructor 00159 */ 00160 ~Unit(); 00161 00165 inline unsigned int getProcessOrder() const { return m_PcsOrder; }; 00166 00170 inline UnitID_t getID() const { return m_ID; }; 00171 00172 00176 inline UnitClass_t getClass() const { return m_Class; }; 00177 00178 inline InstanciationType getIntanceType() const { return m_InstType; }; 00179 00180 00181 bool addToUnit(Unit* aUnit); 00182 00183 bool addFromUnit(Unit* aUnit); 00184 00185 bool addParentUnit(Unit* aUnit); 00186 00187 bool addChildUnit(Unit* aUnit); 00188 00194 UnitsPtrList_t* getToUnits(const UnitClass_t aClass); 00195 00196 const UnitsPtrList_t* getToUnits(const UnitClass_t aClass) const; 00197 00203 UnitsPtrList_t* getFromUnits(const UnitClass_t aClass); 00204 00205 const UnitsPtrList_t* getFromUnits(const UnitClass_t aClass) const; 00206 00212 UnitsPtrList_t* getParentUnits(const UnitClass_t aClass); 00213 00214 const UnitsPtrList_t* getParentUnits(const UnitClass_t aClass) const; 00215 00221 UnitsPtrList_t* getChildrenUnits(const UnitClass_t aClass); 00222 00223 const UnitsPtrList_t* getChildrenUnits(const UnitClass_t aClass) const; 00224 00225 00226 00227 00228 inline InputData<InputDataValue>* getInputData() { return &m_InputData; }; 00229 00230 inline const InputData<InputDataValue>* getInputData() const { return &m_InputData; }; 00231 00232 inline Variables<ScalarValue>* getScalarVariables() { return &m_ScalarVariables; }; 00233 00234 inline const Variables<ScalarValue>* getScalarVariables() const { return &m_ScalarVariables; }; 00235 00236 inline Variables<VectorValue>* getVectorVariables() { return &m_VectorVariables; }; 00237 00238 inline const Variables<VectorValue>* getVectorVariables() const { return &m_VectorVariables; }; 00239 00240 inline EventsCollection* getEvents() { return &m_Events; }; 00241 00242 inline const EventsCollection* getEvents() const { return &m_Events; }; 00243 00244 void streamContents(std::ostream& OStream); 00245 00246 }; 00247 00248 00249 } } // namespaces 00250 00251 00252 #endif /* __UNIT_H__ */ 00253