Main/fg_serial.hxx

   1 // fg_serial.hxx -- Higher level serial port managment routines
   2 //
   3 // Written by Curtis Olson, started November 1998.
   4 //
   5 // Copyright (C) 1998  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 // (Log is kept at end of this file)
  23
  24
  25 #ifndef _FG_SERIAL_HXX
  26 #define _FG_SERIAL_HXX
  27
  28
  29 #ifndef __cplusplus
  30 # error This library requires C++
  31 #endif
  32
  33
  34 #include <string>
  35
  36 #include <Serial/serial.hxx>
  37
  38
  39 class fgIOCHANNEL {
  40
  41 public:
  42
  43     // Types of serial port protocols
  44     enum fgPortKind {
  45         FG_SERIAL_DISABLED = 0,
  46         FG_SERIAL_NMEA_OUT = 1,
  47         FG_SERIAL_NMEA_IN = 2,
  48         FG_SERIAL_GARMIN_OUT = 3,
  49         FG_SERIAL_GARMIN_IN = 4,
  50         FG_SERIAL_FGFS_OUT = 5,
  51         FG_SERIAL_FGFS_IN = 6
  52     };
  53
  54     string device;
  55     string format;
  56     string baud;
  57     string direction;
  58
  59     fgPortKind kind;
  60     fgSERIAL port;
  61     long last_time;
  62     bool valid_config;
  63
  64     fgIOCHANNEL();
  65     ~fgIOCHANNEL();
  66 };
  67
  68
  69 // support up to four serial channels.  Each channel can be assigned
  70 // to an arbitrary port.  Bi-directional communication is supported by
  71 // the underlying layer.
  72
  73 // define the four channels
  74 // extern fgIOCHANNEL port_a;
  75 // extern fgIOCHANNEL port_b;
  76 // extern fgIOCHANNEL port_c;
  77 // extern fgIOCHANNEL port_d;
  78
  79
  80 // initialize serial ports based on command line options (if any)
  81 void fgSerialInit();
  82
  83
  84 // process any serial port work
  85 void fgSerialProcess();
  86
  87
  88 #endif // _FG_SERIAL_HXX
  89
  90
  91 // $Log$
  92 // Revision 1.4  1998/11/30 17:43:34  curt
  93 // Lots of tweaking to get serial output to actually work.
  94 //
  95 // Revision 1.3  1998/11/25 01:33:59  curt
  96 // Support for an arbitrary number of serial ports.
  97 //
  98 // Revision 1.2  1998/11/19 13:53:27  curt
  99 // Added a "Garmin" mode.
 100 //
 101 // Revision 1.1  1998/11/16 13:57:43  curt
 102 // Initial revision.
 103 //