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
  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
  45 class fgIOCHANNEL {
  46
  47 public:
  48
  49     // Types of serial port protocols
  50     enum fgPortKind {
  51         FG_SERIAL_DISABLED = 0,
  52         FG_SERIAL_NMEA_OUT = 1,
  53         FG_SERIAL_NMEA_IN = 2,
  54         FG_SERIAL_GARMIN_OUT = 3,
  55         FG_SERIAL_GARMIN_IN = 4,
  56         FG_SERIAL_FGFS_OUT = 5,
  57         FG_SERIAL_FGFS_IN = 6
  58     };
  59
  60     string device;
  61     string format;
  62     string baud;
  63     string direction;
  64
  65     fgPortKind kind;
  66     fgSERIAL port;
  67     time_t last_time;
  68     bool valid_config;
  69
  70     fgIOCHANNEL();
  71     ~fgIOCHANNEL();
  72 };
  73
  74
  75 // support up to four serial channels.  Each channel can be assigned
  76 // to an arbitrary port.  Bi-directional communication is supported by
  77 // the underlying layer.
  78
  79 // define the four channels
  80 // extern fgIOCHANNEL port_a;
  81 // extern fgIOCHANNEL port_b;
  82 // extern fgIOCHANNEL port_c;
  83 // extern fgIOCHANNEL port_d;
  84
  85
  86 // initialize serial ports based on command line options (if any)
  87 void fgSerialInit();
  88
  89
  90 // process any serial port work
  91 void fgSerialProcess();
  92
  93
  94 #endif // _FG_SERIAL_HXX
  95
  96