Device.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_HPP_
#define _DEVICE_HPP_


#include <ActiveObject.hpp>
#include "DeviceConfigurator.hpp"
#include "StreamOperationHandlerMethod.hpp"
#include "DeviceConfigurator.hpp"

namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      using boost::shared_ptr;
      using mermaid::support::activeobject::ActiveObject;
      
      /**
       * @Class Device Device.hpp "Device.hpp"
       * @Description Device class
       *
       * This is the class which represents a device.
       * @Author Joao Carreira
       */
      class Device
      {
        public:
        
          /**
           * @Description Constructor.
           *
           * @Argument expectedDataSize The size of the data to be read from the device.
           * @Argument fileDescriptor   The device's file descriptor.
           * @Argument owner The ActiveObject of the service using the device.
           * @Argument deviceConfigurator The configurator of the file descriptor
           * @Author Joao Carreira
           */
          Device (int expectedDataSize, int fileDescriptor, shared_ptr<ActiveObject> owner, shared_ptr<DeviceConfigurator> deviceConfigurator);
          virtual ~Device();
          
          /**
           * @Description Call the handler which processes read replies
           *
           * @Argument bytesRead The number of bytes read
           * @Argument requestedBytes The number of bytes requested to be read.
           * @Argument data The data which was read.
           * @Argument success Boolean value which tells if the operation was successful.
           * @Author Joao Carreira
           */
          virtual void callReadHandler (size_t bytesRead, size_t requestedBytes, const char* data, bool success);
          
          /**
           * @Description Call the handler which processes write replies
           *
           * @Argument bytesWritten The number of bytes written
           * @Argument requestedBytes The number of bytes requested to be written
           * @Argument data The data which was written
           * @Argument success Boolean value which tells if the operation was successful.
           * @Author Joao Carreira
           */
          virtual void callWriteHandler (size_t bytesWritten, size_t requestedBytes, const char* data, bool success, shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerWrite);
          
          /**
           * @Description Starts reading from the device and sets the callback method.
           *
           * @Argument streamOperationHandlerRead The handler which will receive read replies.
           * @Author Joao Carreira
           */
          virtual void enableRead (shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerRead);
          
          /**
           * @Description Enables write operations on this device
           *
           * @Author Joao Carreira
           */
          virtual void enableWrite();
          
          /**
           * @Description Writes data to the device.
           *
           * @Argument bytesToWrite Number of bytes to be written
           * @Argument data Data to be written
           * @Author Joao Carreira
           */
          virtual void write (size_t bytesToWrite, const char* data, shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerWrite);
          
          /**
           * @Description File descriptor getter
           *
           * @Returns The device's file descriptor
           * @Author Joao Carreira
           */
          virtual int getFileDescriptor() const {
            return fileDescriptor_;
          }
          
          /**
           * @Description Expected data size getter
           *
           * @Returns The expected size (in bytes) of the read data
           * @Author Joao Carreira
           */
          virtual int getExpectedDataSize() const {
            return expectedDataSize_;
          }
          
          /**
           * @Description Closes the device
           *
           * @Author Joao Carreira
           */
          virtual void close();
          
          /**
           * @Description Configures the device
           *
           * @Author Joao Carreira
           */
          virtual void configureDevice (shared_ptr<DeviceConfigurator>);
          
        private:
          int expectedDataSize_;
          int fileDescriptor_;
          
          bool readEnabled_;
          bool writeEnabled_;
          
          shared_ptr<DeviceConfigurator> deviceConfigurator_;
          shared_ptr<ActiveObject> owner_;
          
          shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerRead_;
          // shared_ptr<StreamOperationHandlerMethodBase> streamOperationHandlerWrite_;
          
      }; // class Device
      
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif //_DEVICE_HPP_