Simulator/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 #include "Include/compiler.h"
  34
  35 #include <string>
  36
  37 #ifdef FG_HAVE_STD_INCLUDES
  38 #  include <ctime>
  39 #else
  40 #  include <time.h>
  41 #endif
  42
  43 #include <Serial/serial.hxx>
  44
  45
  46 class fgIOCHANNEL {
  47
  48 public:
  49
  50     // Types of serial port protocols
  51     enum fgPortKind {
  52         FG_SERIAL_DISABLED = 0,
  53         FG_SERIAL_NMEA_OUT = 1,
  54         FG_SERIAL_NMEA_IN = 2,
  55         FG_SERIAL_GARMIN_OUT = 3,
  56         FG_SERIAL_GARMIN_IN = 4,
  57         FG_SERIAL_FGFS_OUT = 5,
  58         FG_SERIAL_FGFS_IN = 6
  59     };
  60
  61     string device;
  62     string format;
  63     string baud;
  64     string direction;
  65
  66     fgPortKind kind;
  67     fgSERIAL port;
  68     time_t last_time;
  69     bool valid_config;
  70
  71     fgIOCHANNEL();
  72     ~fgIOCHANNEL();
  73 };
  74
  75
  76 // support up to four serial channels.  Each channel can be assigned
  77 // to an arbitrary port.  Bi-directional communication is supported by
  78 // the underlying layer.
  79
  80 // define the four channels
  81 // extern fgIOCHANNEL port_a;
  82 // extern fgIOCHANNEL port_b;
  83 // extern fgIOCHANNEL port_c;
  84 // extern fgIOCHANNEL port_d;
  85
  86
  87 // initialize serial ports based on command line options (if any)
  88 void fgSerialInit();
  89
  90
  91 // process any serial port work
  92 void fgSerialProcess();
  93
  94
  95 #endif // _FG_SERIAL_HXX
  96
  97
  98 // $Log$
  99 // Revision 1.5  1999/01/21 00:55:02  curt
 100 // Fixed some problems with timing of output strings.
 101 // Added checksum support for nmea and garmin output.
 102 //
 103 // Revision 1.4  1998/11/30 17:43:34  curt
 104 // Lots of tweaking to get serial output to actually work.
 105 //
 106 // Revision 1.3  1998/11/25 01:33:59  curt
 107 // Support for an arbitrary number of serial ports.
 108 //
 109 // Revision 1.2  1998/11/19 13:53:27  curt
 110 // Added a "Garmin" mode.
 111 //
 112 // Revision 1.1  1998/11/16 13:57:43  curt
 113 // Initial revision.
 114 //