SerialPort.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_SerialPort_hxx
#define __ccxx_SerialPort_hxx

#include <commonc++/Common.h++>
#include <commonc++/Stream.h++>
#include <commonc++/String.h++>

namespace ccxx {

class COMMONCPP_API SerialPort : public Stream
{
 public:

  enum BaudRate { BaudOther = -1, Baud300 = 300, Baud600 = 600,
                  Baud1200 = 1200, Baud1800 = 1800, Baud2400 = 2400,
                  Baud4800 = 4800, Baud9600 = 9600, Baud19200 = 19200,
                  Baud38400 = 38400, Baud57600 = 57600,
                  Baud115200 = 115200, Baud230400 = 230400 };

  enum Parity { ParityOther = -1, ParityNone, ParityOdd, ParityEven,
                ParityMark, ParitySpace };

  enum DataBits { DataBitsOther = -1, DataBits5 = 5, DataBits6 = 6,
                  DataBits7 = 7, DataBits8 = 8 };

  enum StopBits { StopBitsOther = -1, StopBits1 = 1, StopBits2 = 2,
                  StopBits1_5 = 3 };

  enum FlowControl { FlowOther = -1, FlowOff, FlowHardware, FlowXOnXOff };

  SerialPort(const String& device);

  virtual ~SerialPort();

  virtual void open();

  void flush();

  void setTimeout(timespan_ms_t timeout);

  void setBaudRate(BaudRate baud);

  BaudRate getBaudRate();

  void setParity(Parity parity);

  Parity getParity();

  void setDataBits(DataBits bits);

  DataBits getDataBits();

  void setStopBits(StopBits bits);

  StopBits getStopBits();

  void setFlowControl(FlowControl flow);

  FlowControl getFlowControl();

  void sendBreak(uint_t duration);

  inline String getDevice() const
  { return(_device); }

  static BaudRate lookupBaudRate(uint_t baudRate);

 private:

  String _device;

  CCXX_COPY_DECLS(SerialPort);
};

} // namespace ccxx

#endif // __ccxx_SerialPort_hxx