src/Network/fg_serial.hxx

   1 // fg_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 _FG_SERIAL_HXX
  25 #define _FG_SERIAL_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #include "Include/compiler.h"
  33
  34 #include <string>
  35
  36 // #ifdef FG_HAVE_STD_INCLUDES
  37 // #  include <ctime>
  38 // #else
  39 // #  include <time.h>
  40 // #endif
  41
  42 #include <Serial/serial.hxx>
  43
  44 #include "iochannel.hxx"
  45 #include "protocol.hxx"
  46
  47 FG_USING_STD(string);
  48
  49
  50 class FGSerial : public FGIOChannel {
  51
  52     string device;
  53     string baud;
  54     FGSerialPort port;
  55
  56     char save_buf[ 2 * FG_MAX_MSG_SIZE ];
  57     int save_len;
  58
  59 public:
  60
  61     FGSerial();
  62     ~FGSerial();
  63
  64     // open the serial port based on specified direction
  65     bool open( FGProtocol::fgProtocolDir dir );
  66
  67     // read a block of data of specified size
  68     int read( char *buf, int length );
  69
  70     // read a line of data, length is max size of input buffer
  71     int readline( char *buf, int length );
  72
  73     // write data to port
  74     int write( char *buf, int length );
  75
  76     // write null terminated string to port
  77     int writestring( char *str );
  78
  79     // close port
  80     bool close();
  81
  82     inline string get_device() const { return device; }
  83     inline void set_device( const string& d ) { device = d; }
  84     inline string get_baud() const { return baud; }
  85     inline void set_baud( const string& b ) { baud = b; }
  86 };
  87
  88
  89 #endif // _FG_SERIAL_HXX
  90
  91