src/Network/generic.hxx

   1 // generic.hxx -- generic protocol class
   2 //
   3 // Written by Curtis Olson, started November 1999.
   4 //
   5 // Copyright (C) 1999  Curtis L. Olson - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _FG_SERIAL_HXX
  25 #define _FG_SERIAL_HXX
  26
  27
  28 #include <simgear/compiler.h>
  29
  30 #include <string>
  31
  32 #include "protocol.hxx"
  33
  34 using std::string;
  35
  36
  37 class FGGeneric : public FGProtocol {
  38
  39 public:
  40
  41     FGGeneric(vector<string>);
  42     ~FGGeneric();
  43
  44     bool gen_message();
  45     bool parse_message_len(int length);
  46
  47     // open hailing frequencies
  48     bool open();
  49
  50     void reinit();
  51
  52     // process work for this port
  53     bool process();
  54
  55     // close the channel
  56     bool close();
  57
  58     void setExitOnError(bool val) { exitOnError = val; }
  59     bool getExitOnError() { return exitOnError; }
  60     bool getInitOk(void) { return initOk; }
  61 protected:
  62
  63     enum e_type { FG_BOOL=0, FG_INT, FG_FLOAT, FG_DOUBLE, FG_STRING, FG_FIXED };
  64
  65     typedef struct {
  66      // string name;
  67         string format;
  68         e_type type;
  69         double offset;
  70         double factor;
  71         double min, max;
  72         bool wrap;
  73         bool rel;
  74         SGPropertyNode_ptr prop;
  75     } _serial_prot;
  76
  77 private:
  78
  79     string file_name;
  80     string direction;
  81
  82     int length;
  83     char buf[ FG_MAX_MSG_SIZE ];
  84
  85     string preamble;
  86     string postamble;
  87     string var_separator;
  88     string line_separator;
  89     string var_sep_string;
  90     string line_sep_string;
  91     vector<_serial_prot> _out_message;
  92     vector<_serial_prot> _in_message;
  93
  94     bool binary_mode;
  95     enum {FOOTER_NONE, FOOTER_LENGTH, FOOTER_MAGIC} binary_footer_type;
  96     int binary_footer_value;
  97     int binary_record_length;
  98     enum {BYTE_ORDER_NEEDS_CONVERSION, BYTE_ORDER_MATCHES_NETWORK_ORDER} binary_byte_order;
  99
 100     bool gen_message_ascii();
 101     bool gen_message_binary();
 102     bool parse_message_ascii(int length);
 103     bool parse_message_binary(int length);
 104     bool read_config(SGPropertyNode *root, vector<_serial_prot> &msg);
 105     bool exitOnError;
 106     bool initOk;
 107
 108     template<class T>
 109     static void updateValue(_serial_prot& prot, const T& val)
 110     {
 111       T new_val = (prot.rel ? getValue<T>(prot.prop) : 0)
 112                 + prot.offset
 113                 + prot.factor * val;
 114
 115       if( prot.max > prot.min )
 116       {
 117         if( prot.wrap )
 118           new_val = SGMisc<double>::normalizePeriodic(prot.min, prot.max, new_val);
 119         else
 120           new_val = SGMisc<T>::clip(new_val, prot.min, prot.max);
 121       }
 122
 123       setValue(prot.prop, new_val);
 124     }
 125
 126     // Special handling for bool (relative change = toggle, no min/max, no wrap)
 127     static void updateValue(_serial_prot& prot, bool val);
 128 };
 129
 130
 131 #endif // _FG_SERIAL_HXX
 132
 133