PlugInManager.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_libCore_PlugInManager_hpp_
#define _GranOO_libCore_PlugInManager_hpp_
 
#include <string>
#include <map>
#include <vector>
#include <functional>
 
// Class PlugInManager is singleton.
// Only one object of type PlugInManager can be instantiate:
// constructor is protected, one must use the public static mathod CreateSpecificObject()
 
class TiXmlElement;
 
namespace GranOO3
{
  namespace Core
  {
    class PlugIn;
    class PlugInManager;
 
    std::ostream& operator<< (std::ostream &, const PlugInManager &);//Usefull to debug
 
 
 
    class PlugInManager
    {
      friend std::ostream& operator<< (std::ostream &, const PlugInManager &);
 
    public:
      static std::string get_plugin_str_key() {return std::string("PlugIn");}
      static PlugInManager & get();
 
    public:
      //CONSTRUCTORS & DESTRUCTORS
      virtual ~PlugInManager();
 
      //USEFULL
      std::vector<PlugIn*> read_xml_file(const std::string & xPathParent, bool verbose = false);
      std::vector<PlugIn*> read_xml_parent_element(const TiXmlElement* el, bool verbose = false);
      PlugIn* read_xml_element(const TiXmlElement* el, bool verbose = false);
 
 
      template<typename T> std::vector<PlugIn*> read_xml_file_with_parent_property_required(const std::string & xPathParent,
                                                                                            const std::string& xmlTag,
                                                                                            const T& valueRequired);
      bool record(const std::string & id, std::function<PlugIn * ()>);
 
    private:
      PlugInManager & operator=(const PlugInManager &); //not allowed
      PlugInManager(const PlugInManager &);             //not allowed
 
      PlugInManager();
      std::map<const std::string, std::function<PlugIn * ()> >& get_map();
      const std::map<const std::string, std::function<PlugIn * ()> >& get_map() const;
      std::vector<std::string> get_plugin_list() const;
 
    private:
      static PlugInManager * _the_plugin_manager;
      std::map<const std::string, std::function<PlugIn * ()> > _the_map;
    };
 
 
 
 
 
  }
}
 
#endif