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 __GENERATOR_HPP__ 00042 #define __GENERATOR_HPP__ 00043 00044 #include <openfluid/dllexport.hpp> 00045 #include <openfluid/ware/PluggableSimulator.hpp> 00046 #include <openfluid/fluidx/GeneratorDescriptor.hpp> 00047 00048 namespace openfluid { namespace machine { 00049 00050 class DLLEXPORT Generator : public openfluid::ware::PluggableSimulator 00051 { 00052 protected: 00053 00054 openfluid::core::VariableName_t m_VarName; 00055 00056 openfluid::core::UnitClass_t m_UnitClass; 00057 00058 openfluid::fluidx::GeneratorDescriptor::GeneratorMethod m_GenMethod; 00059 00060 unsigned int m_VarSize; 00061 00062 00063 public: 00064 00065 Generator(); 00066 00067 ~Generator(); 00068 00069 00070 void setInfos(openfluid::core::VariableName_t VarName, openfluid::core::UnitClass_t UnitClass, 00071 openfluid::fluidx::GeneratorDescriptor::GeneratorMethod GenMethod, unsigned int VarSize=1) 00072 { m_VarName = VarName; m_UnitClass = UnitClass; m_GenMethod = GenMethod; m_VarSize = VarSize; }; 00073 00074 openfluid::core::VariableName_t getVariableName() const { return m_VarName; }; 00075 00076 openfluid::core::UnitClass_t getUnitClass() const { return m_UnitClass; }; 00077 00078 openfluid::fluidx::GeneratorDescriptor::GeneratorMethod getGeneratorMethod() const { return m_GenMethod; }; 00079 00080 inline bool isVectorVariable() const { return (m_VarSize > 1); }; 00081 00082 inline bool isScalarVariable() const { return (!isVectorVariable()); }; 00083 00084 inline unsigned int getVariableSize() const { return m_VarSize; }; 00085 00086 00087 virtual void prepareData() {}; 00088 00089 }; 00090 00091 } } //namespaces 00092 00093 00094 00095 #endif /* __GENERATOR_H___ */