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 <map>
#include <memory>
#include <unordered_map>
 
#include "uhal/log/exception.hpp"
#include "uhal/ClientInterface.hpp"
#include "uhal/log/log.hpp"
 
 
namespace uhal
{
  namespace 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 ( ProtocolNotEnabled , "Exception class to handle the case where the protocol for a user client has not been enabled." )
 
    UHAL_DEFINE_EXCEPTION_CLASS ( FailedToParseURI , "Exception class to handle the case where the factory failed to parse URI." )
  }
 
  class ClientFactory
  {
 
    private:
      ClientFactory();
 
    public:
 
      ClientFactory(const ClientFactory&) = delete;
      ClientFactory& operator=(const ClientFactory&) = delete;
 
      virtual ~ClientFactory();
 
      static ClientFactory& getInstance();
 
      std::shared_ptr<ClientInterface> getClient ( const std::string& aId , const std::string& aUri );
 
      std::shared_ptr<ClientInterface> getClient ( const std::string& aId , const std::string& aUri, const std::vector<std::string>& aUserClientActivationList );
 
      template <class T>
      void registerClient ( const std::string& aProtocol , const std::string& aDescription = "" );
 
      template <class T>
      class RegistrationHelper {
      public:
        static bool sInitialised;
 
        static bool init(const std::string& aUri, const std::string& aDescription);
      };
 
    private:
 
      template <class T>
      void add ( const std::string& aProtocol , const std::string& aDescription, bool aUserDefined );
 
      class CreatorInterface
      {
        public:
          CreatorInterface()
          {
          }
 
          virtual ~CreatorInterface()
          {
          }
 
          virtual std::shared_ptr<ClientInterface> create ( const std::string& aId , const URI& aUri ) = 0;
      };
 
      template <class T>
      class Creator: public CreatorInterface
      {
        public:
 
          Creator()
          {
          }
 
          virtual ~Creator()
          {
          }
 
          std::shared_ptr<ClientInterface> create ( const std::string& aId , const URI& aUri );
      };
 
 
    private:
 
      struct ClientInfo {
        std::shared_ptr<CreatorInterface> creator;
        bool userDefined;
        std::string description;
      };
 
      static std::shared_ptr<ClientFactory> mInstance;
      std::unordered_map< std::string , ClientInfo > mClientMap; //map string name of each protocol to a creator for that protocol
  };
 
}
 
#define UHAL_REGISTER_EXTERNAL_CLIENT(clientclass, clienturi, clientdescription) \
  template<> bool uhal::ClientFactory::RegistrationHelper<clientclass>::sInitialised = \
    uhal::ClientFactory::RegistrationHelper<clientclass>::init(clienturi, clientdescription);
 
 
#include "uhal/TemplateDefinitions/ClientFactory.hxx"
 
#endif