DataFeedInputHandlerMethod.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 DataFeedInputHandlerMethod.hpp
* @Description DataFeedInputHandlerMethod
* @Status Work in Progress
* @Version $Id: DataFeedInputHandlerMethod.hpp 1 2011-03-04 18:13:18Z jreis $
* @Maintainer Marco Barbosa
*/

#ifndef __SERVICE_DATAFEEDINPUTHANDLERMETHOD_H
#define __SERVICE_DATAFEEDINPUTHANDLERMETHOD_H


#include <DataBox.hpp>

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

#endif // __SERVICE_DATAFEEDINPUTHANDLERMETHOD_H