Generator.hpp

Go to the documentation of this file.

/*
 
  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro
 
 
 == GNU General Public License Usage ==
 
  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  OpenFLUID is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
 
 
 == Other Usage ==
 
  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/
 
 
/**
  @file Generator.hpp
 
  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
  @author Armel THÖNI <armel.thoni@inrae.fr>
*/
 
 
#ifndef __OPENFLUID_MACHINE_GENERATOR_HPP__
#define __OPENFLUID_MACHINE_GENERATOR_HPP__
 
 
#include <openfluid/dllexport.hpp>
#include <openfluid/ware/PluggableSimulator.hpp>
#include <openfluid/fluidx/GeneratorDescriptor.hpp>
 
 
namespace openfluid { namespace machine {
 
 
class OPENFLUID_API Generator : public openfluid::ware::PluggableSimulator
{
  protected:
 
    openfluid::fluidx::GeneratorDescriptor::GeneratorMethod m_GenMethod;
 
    openfluid::core::Dimensions m_VarDimensions;
    
    openfluid::tools::UnitVarTriplets_t m_VarTriplets;
 
 
  public:
 
    Generator() : PluggableSimulator()
    {
    }
 
    virtual ~Generator()
    {
    }
 
 
    void setInfos(openfluid::tools::UnitVarTriplets_t Triplets,
                  openfluid::fluidx::GeneratorDescriptor::GeneratorMethod GenMethod, 
                  openfluid::core::Dimensions VarDimensions=openfluid::core::Dimensions());
 
    openfluid::fluidx::GeneratorDescriptor::GeneratorMethod getGeneratorMethod() const;
 
 
    virtual void prepareData()
    {
    }
};
 
 
// =====================================================================
// =====================================================================
 
 
class OPENFLUID_API MonoGenerator : public Generator
{
  protected:
 
    openfluid::core::VariableName_t m_VarName;
 
    openfluid::core::UnitsClass_t m_UnitsClass;
 
 
  public:
 
    MonoGenerator() : Generator()
    {
    }
 
    virtual ~MonoGenerator()
    {
    }
 
 
    void setInfos(openfluid::tools::UnitVarTriplets_t Triplets,
                  openfluid::fluidx::GeneratorDescriptor::GeneratorMethod GenMethod, 
                  openfluid::core::Dimensions VarDimensions=openfluid::core::Dimensions());
 
    openfluid::core::VariableName_t getVariableName() const;
 
    openfluid::core::UnitsClass_t getUnitsClass() const;
 
    /**
      @deprecated Since version 2.1.0. Use openfluid::machine::Generator::getUnitsClass() const instead
    */
    [[deprecated]] openfluid::core::UnitsClass_t getUnitClass() const;
 
};
 
 
} } //namespaces
 
 
#endif /* __OPENFLUID_MACHINE_GENERATOR_HPP__ */