serial.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2001 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the conexus library.                             *
 *                                                                         *
 *   The conexus library is free software; you can redistribute it and/or  *
 *   modify it under the terms of the GNU General Public License           *
 *   version 3 as published by the Free Software Foundation.               *
 *                                                                         *
 *   The conexus library 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   *
 *   General Public License for more details.                              *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this software. If not see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/
#ifndef CONEXUSSERIAL_H
#define CONEXUSSERIAL_H

#include <conexus/conexus-config.h>
#include <conexus/filedescriptor.h>
#include <conexus/serial_interface.h>

namespace Conexus
{

  class Serial : public FileDescriptor, public virtual SerialInterface
  {
    protected:

      Serial( const std::string& device = std::string(), ReadWrite rwmode = READ_WRITE );

    public:

      typedef ConexusPointer<Serial> pointer;
      
      CONEXUS_ENDPOINT_GENERIC_CREATE();

      static Serial::pointer create( const std::string& device = std::string(), ReadWrite rwmode = READ_WRITE );

      virtual ~Serial();
      
      virtual void open( const std::string& device, ReadWrite rwmode = READ_WRITE_UNCHANGED ) throw ( open_exception );

      virtual void open() throw ( open_exception );

      virtual uint32_t rw_mode();

      virtual std::string device();

      virtual void set_device( const std::string& device, ReadWrite rwmode = READ_WRITE_UNCHANGED ) throw ( open_exception );
      
      virtual sigc::signal<void>& signal_device_changed();
      
      #ifdef CONEXUS_HAVE_UDEV

      struct Device {
        Device(const std::string& n, const std::string& p):
            name(n), path(p) { }
        std::string name;
        std::string path;
      };
      
      typedef std::vector<Device> Devices;
      
      static Devices enumerate_devices(bool include_virtuals=false);
      #endif

    protected:
      std::string m_device;
      ReadWrite m_rwmode;

      sigc::signal<void> m_signal_device_changed;
  };

}

#endif