DeviceHandle.hpp

/*
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/>.
*/



#ifndef _DEVICE_HANDLE_HPP_
#define _DEVICE_HANDLE_HPP_


#include <cstring>
#include "StreamOperationHandlerMethod.hpp"
#include "Device.hpp"
#include "DeviceConfigurator.hpp"

namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using boost::shared_ptr;
      
      /**
       * @Class DeviceHandle DeviceHandle.hpp "DeviceHandle.hpp"
       * @Description DeviceHandle class
       *
       * This is the class which abstracts the device.
       * @Author Joao Carreira
       */
      class DeviceHandle
      {
        public:
        
          /**
           * @Description Constructor.
           *
           * @Argument device The device which this handle refers to.
           * @Author Joao Carreira
           */
          DeviceHandle (shared_ptr<Device> device);
          
          /**
           * @Description Starts reading from the device.
           *
           * @Argument streamOperationHandlerRead The handler which will receive read replies.
           * @Author Joao Carreira
           */
          virtual void enableRead (shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerRead);
          
          /**
           * @Description Writes data to the device.
           *
           * @Argument bytesToWrite Number of bytes to be written
           * @Argument data Data to be written
          * @Argument streamOperationHandlerWrite The handler which will receive the operation reply
           * @Author Joao Carreira
           */
          virtual void write (size_t bytesToWrite, const char* data, shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerWrite);
          
          /**
           * @Description Closes the device
           *
           * @Author Joao Carreira
           */
          virtual void close();
          
          //TODO: check if this is really needed. Should DeviceConfigurator be called in the IOThread?
          /**
           * @Description configures this device
           *
           * @Author Joao Carreira
           */
          virtual void configureDevice (shared_ptr<DeviceConfigurator>);
          
          /**
           * @Description Destructor.
           * @Author Joao Carreira
           */
          virtual ~DeviceHandle();
          
        private:
        
          shared_ptr<Device> device_;
          bool closed_;
          
      }; // class DeviceHandle
      
    } // namespace  io
  } // namespace support
} // namespace mermaid


#endif //_DEVICE_HANDLE_HPP_