DerivedNodeFactory.hpp

Go to the documentation of this file.

/*
---------------------------------------------------------------------------

    This file is part of uHAL.

    uHAL is a hardware access library and programming framework
    originally developed for upgrades of the Level-1 trigger of the CMS
    experiment at CERN.

    uHAL 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.

    uHAL 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 uHAL.  If not, see <http://www.gnu.org/licenses/>.


      Andrew Rose, Imperial College, London
      email: awr01 <AT> imperial.ac.uk

      Marc Magrans de Abril, CERN
      email: marc.magrans.de.abril <AT> cern.ch

---------------------------------------------------------------------------
*/

#ifndef _uhal_DerivedNodeFactory_hpp_
#define _uhal_DerivedNodeFactory_hpp_


#include <string>

#include <boost/noncopyable.hpp>
#include <boost/unordered_map.hpp>


namespace boost {
  template <class Y> class shared_ptr;
}

namespace uhal
{
  class Node;
  class NodeTreeBuilder;   // IWYU pragma: keep

  template< typename T > struct RegistrationHelper;   // IWYU pragma: keep


  class DerivedNodeFactory: private boost::noncopyable
  {
    friend class NodeTreeBuilder;

    public:

      template< typename T > friend struct RegistrationHelper;

    private:
      DerivedNodeFactory ();

      virtual ~DerivedNodeFactory ();


    public:
      static DerivedNodeFactory& getInstance();


    private:

      Node* convertToClassType( Node* aNode );

      /*
      Method to create an associate between a node type identifier and a Creator of that particular node type
      @param aNodeClassName the node type identifier
      */
      template <class T>
      void add ( const std::string& aNodeClassName );


      class CreatorInterface
      {
        public:
          CreatorInterface()
          {
          }
          virtual ~CreatorInterface()
          {
          }
          virtual Node* create ( const Node& aNode ) = 0;
      };


      template <class T>
      class Creator: public CreatorInterface
      {
        public:

          Creator()
          {
          }
          virtual ~Creator()
          {
          }
          Node* create ( const Node& aNode );
      };


    private:
      static DerivedNodeFactory* mInstance;

      boost::unordered_map< std::string , boost::shared_ptr< CreatorInterface > > mCreators;

  };
}

#include "uhal/TemplateDefinitions/DerivedNodeFactory.hxx"

#endif