simgear/io/sg_serial.hxx

   1 // sg_serial.hxx -- Serial I/O routines
   2 //
   3 // Written by Curtis Olson, started November 1999.
   4 //
   5 // Copyright (C) 1999  Curtis L. Olson - curt@flightgear.org
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _SG_SERIAL_HXX
  25 #define _SG_SERIAL_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #include <simgear/compiler.h>
  33
  34 #include <string>
  35
  36 // #ifdef SG_HAVE_STD_INCLUDES
  37 // #  include <ctime>
  38 // #else
  39 // #  include <time.h>
  40 // #endif
  41
  42 #include <simgear/serial/serial.hxx>
  43
  44 #include "iochannel.hxx"
  45
  46 SG_USING_STD(string);
  47
  48
  49 class SGSerial : public SGIOChannel {
  50
  51     string device;
  52     string baud;
  53     FGSerialPort port;
  54
  55     char save_buf[ 2 * SG_IO_MAX_MSG_SIZE ];
  56     int save_len;
  57
  58 public:
  59
  60     SGSerial( const string& device_name, const string& baud_rate );
  61     ~SGSerial();
  62
  63     // open the serial port based on specified direction
  64     bool open( const SGProtocolDir d );
  65
  66     // read a block of data of specified size
  67     int read( char *buf, int length );
  68
  69     // read a line of data, length is max size of input buffer
  70     int readline( char *buf, int length );
  71
  72     // write data to port
  73     int write( const char *buf, const int length );
  74
  75     // write null terminated string to port
  76     int writestring( const char *str );
  77
  78     // close port
  79     bool close();
  80
  81     inline string get_device() const { return device; }
  82     inline string get_baud() const { return baud; }
  83 };
  84
  85
  86 #endif // _SG_SERIAL_HXX
  87
  88