FunctionT.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_Math_FunctionT_hpp_
#define _GranOO_Math_FunctionT_hpp_
 
#include <type_traits>
 
#include "GranOO3/Math/Function.hpp"
#include "GranOO3/Math/Symbol.hpp"
#include "GranOO3/Core/Macro.hpp"
#include "GranOO3/Core/Doc.hpp"
 
namespace GranOO3
{
  namespace Math
  {
 
    template<class T>
    class FunctionT : public Function
    {
    public:
      FunctionT(unsigned int varNumber);
      FunctionT(unsigned int varNumber, const std::string& symbol, const std::string desc = "");
      virtual ~FunctionT();
 
      void record(const std::string&);
 
    private:
      FunctionT()                           = delete;
      FunctionT(const FunctionT&)            = delete;
      FunctionT& operator=(const FunctionT&) = delete;
 
    private:
      std::string _symbol;
      bool _recorded;
    };
 
    template<class T>
    inline
    FunctionT<T>::FunctionT(unsigned int varNumber)
      : Function(varNumber),
      _symbol(""),
      _recorded(false) {
      static_assert(std::is_base_of<FunctionT<T>, T>::value,
                    "T must be a descendant of Function<T>");
    }
 
    template<class T>
    inline
    FunctionT<T>::FunctionT(unsigned int varNumber, const std::string& symbol, const std::string desc)
      : Function(varNumber),
      _symbol(""),
      _recorded(false) {
      static_assert(std::is_base_of<FunctionT<T>, T>::value,
                    "T must be a descendant of Function<T>");
      record(symbol);
 
      if (desc != "")
        Core::Doc::add("Math::Function", T::class_ID(), __FILE__, desc);
    }
 
    template<class T>
    inline
    FunctionT<T>::~FunctionT() {
      if (_recorded) {
        const bool ok = Symbol::Table().remove_function(_symbol);
        AssertMsg(ok == true, "Can't deregister this function");
        AssertMsg(_recorded_function.count(_symbol)==1, "Can't find this symbol in map");
        _recorded_function.erase(_symbol);
      }
    }
 
    template<class T>
    inline void
    FunctionT<T>::record(const std::string& symbol) {
      AssertMsg(_recorded_function.count(symbol) == 0, "This symbol is already used");
      AssertMsg(_recorded == false, "This function was already registered");
      _symbol = symbol;
      AssertMsg(symbol != "", "The symbol can not be empty");
      _recorded = true;
      const bool ok = Symbol::Table().add_function(_symbol, static_cast<T&>(*this));
      AssertMsg(ok == true, "Can't register this function");
      _recorded_function[symbol] = this;
    }
 
  }
}
#endif