ServiceInterfaceHandlerMethod.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

MeRMaID 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
* @Filename ServiceInterfaceHandlerMethod.hpp
* @Description ServiceInterfaceHandlerMethod
* @Status Work in Progress
* @Version $Id: ServiceInterfaceHandlerMethod.hpp 1 2011-03-04 18:13:18Z jreis $
* @Maintainer Marco Barbosa
*/

#ifndef __SERVICE_SERVICEINTERFACEHANDLERMETHOD_H
#define __SERVICE_SERVICEINTERFACEHANDLERMETHOD_H

#include <ServiceRequest.hpp>
#include <ServiceReply.hpp>




namespace mermaid
{
  namespace support
  {
    namespace service
    {
    
      using boost::shared_ptr;
      
      /**
      * @Class ServiceInterfaceHandlerMethodBase ServiceInterfaceHandlerMethod.hpp "ServiceInterfaceHandlerMethod.hpp"
      * @Description Base class for all ServiceInterfaceHandlerMethod objects.
      *
      * This class is needed in order to call ServiceInterfaceHandlerMethod without having to know the specific class used by the template.
      * @Author Marco Barbosa
      */
      class ServiceInterfaceHandlerMethodBase
      {
        public:
          /**
          * @Description Handler call method.
          *
          * This method calls the handler to which the instance of this class points to.
          * @Author Marco Barbosa
          */
          virtual void callHandler (shared_ptr<ServiceRequest> request, shared_ptr<ServiceReply> reply) = 0;
      };
      
      
      /**
      * @Class ServiceInterfaceHandlerMethod ServiceInterfaceHandlerMethod.hpp "ServiceInterfaceHandlerMethod.hpp"
      * @Description Class that stores a pointer to a method of an object. It holds a pointer to a method suitable for handling service requests.
      * @Author Marco Barbosa
      */
      template <class o>
      class ServiceInterfaceHandlerMethod : public ServiceInterfaceHandlerMethodBase
      {
          typedef void (o::*SERVICE_INTERFACE_HANDLER_METHOD) (shared_ptr<ServiceRequest> request, shared_ptr<ServiceReply> reply);
        public:
          /**
          * @Description Contstructor.
          * @Argument object Object instance on which the method shall be called
          * @Argument method Method of the object's class
          */
          ServiceInterfaceHandlerMethod (o * object, SERVICE_INTERFACE_HANDLER_METHOD method) {
            object_ = object;
            method_ = method;
          }
          
          /**
          * @Description Method call
          * @Argument dataBox DataBox containing the input data.
          */
          virtual void callHandler (shared_ptr<ServiceRequest> request, shared_ptr<ServiceReply> reply) {
            (object_->*method_) (request, reply);
          }
          
        private:
          o * object_;
          SERVICE_INTERFACE_HANDLER_METHOD method_;
      }; // class ServiceInterfaceHandlerMethod
    } // namespace service
  } // namespace support
} // namespace mermaid

#endif // __SERVICE_SERVICEINTERFACEHANDLERMETHOD_H