Variable.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Damien Andre       IRCER/UNILIM, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jean-luc Charles   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jean-luc.charles@ensam.eu>
//                - Jeremie Girardot   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert      LAMIH/UPHF, Valenciennes France
//                  <cedric.hubert@uphf.fr>
//                - Ivan Iordanoff     Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <ivan.iordanoff@ensam.eu>
//
// Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
//
// This program 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.
//
// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#ifndef GranOO_Item__Variablehpp
#define GranOO_Item__Variablehpp
 
#include <string>
 
#include "GranOO3/Core/Macro.hpp"
#include "GranOO3/Core/Mapped.hpp"
 
 
namespace GranOO3
{
  namespace Math
  {
    // This class is used for exporting mathematical variable
    // and use it in exprtk
    class Variable : public Core::Mapped<Variable>
    {
      GRANOO_MAPPED_GET(Variable);
 
    public:
      static Variable& glob(const std::string& id);
      static std::string class_ID() {return "Variable";}
 
    public:
      Variable(const std::string& id, double& var);
      Variable(const std::string& id, double& var, const std::string& desc);
      ~Variable();
 
      GRANOO_ACCESS(val, double, _variable);
      const std::string& symbol() const;
 
    private:
      Variable()                           = delete;
      Variable(const Variable&)            = delete;
      Variable& operator=(const Variable&) = delete;
 
    private:
      double& _variable;
      const std::string _symbol;
      const std::string _description;
    };
  }
}
#endif