ClientFactory.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_ClientFactory_hpp_
#define _uhal_ClientFactory_hpp_

#include "uhal/log/exception.hpp"
#include "uhal/ClientInterface.hpp"
#include "uhal/log/log.hpp"

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

#include <map>


namespace uhal
{
  namespace exception
  {
    // //! Exception class to handle the case where a protocol already exists in the creator map. Uses the base uhal::exception implementation of what()
    // class ProtocolAlreadyExist : public exception {};
    UHAL_DEFINE_EXCEPTION_CLASS ( ProtocolDoesNotExist , "Exception class to handle the case where the protocol requested does not exists in the creator map." )

    
    UHAL_DEFINE_EXCEPTION_CLASS ( FailedToParseURI , "Exception class to handle the case where the factory failed to parse URI." )
  }

  class ClientFactory: private boost::noncopyable
  {

    private:
      ClientFactory();

      virtual ~ClientFactory();

    public:
      static ClientFactory& getInstance();

      template <class T>
      void add ( const std::string& aProtocol , const std::string& aDescription = "" );

      boost::shared_ptr<ClientInterface> getClient ( const std::string& aId , const std::string& aUri );

    private:
      class CreatorInterface
      {
        public:
          CreatorInterface()
          {
          }
          virtual ~CreatorInterface()
          {
          }
          virtual boost::shared_ptr<ClientInterface> create ( const std::string& aId , const URI& aUri ) = 0;
      };

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

          Creator()
          {
          }
          virtual ~Creator()
          {
          }
          boost::shared_ptr<ClientInterface> create ( const std::string& aId , const URI& aUri );
      };


    private:
      static ClientFactory* mInstance;
      boost::unordered_map< std::string , boost::shared_ptr< CreatorInterface > > mCreators; //map string name of each protocol to a creator for that protocol
      std::map< std::string , std::string > mProductDescriptions;

  };

}

#include "uhal/TemplateDefinitions/ClientFactory.hxx"

#endif