DeviceConfigurator.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_CONFIGURATOR_HPP_
#define _DEVICE_CONFIGURATOR_HPP_

namespace mermaid
{
  namespace support
  {
    namespace io
    {
    
      /**
       * @Class DeviceConfigurator DeviceConfigurator.hpp "DeviceConfigurator.hpp"
       * @Description DeviceConfigurator class
       *
       * This is the class which configures devices
       * @Author Joao Carreira
       */
      class DeviceConfigurator
      {
        public:
        
          /**
           * @Description Constructor.
           *
           * @Author Joao Carreira
           */
          DeviceConfigurator();
          
          /**
           * @Description Configure a device
           *
           * @Argument fileDescriptor The file descriptor to be configured
           * Configure the given device
           * @Author Joao Carreira
           */
          virtual void configureDevice (int fileDescriptor);
          
          /**
           * @Description Destructor.
           * @Author Joao Carreira
           */
          virtual ~DeviceConfigurator();
        private:
        
      }; // class DeviceConfigurator
      
    } // namespace io
  } // namespace support
} // namespace mermaid

#endif //_DEVICE_CONFIGURATOR_HPP_