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 class FGGeneric : public FGProtocol {
  37
  38 public:
  39
  40     FGGeneric(vector<string>);
  41     ~FGGeneric();
  42
  43     bool gen_message();
  44     bool parse_message_len(int length);
  45
  46     // open hailing frequencies
  47     bool open();
  48
  49     void reinit();
  50
  51     // process work for this port
  52     bool process();
  53
  54     // close the channel
  55     bool close();
  56
  57     void setExitOnError(bool val) { exitOnError = val; }
  58     bool getExitOnError() { return exitOnError; }
  59     bool getInitOk(void) { return initOk; }
  60 protected:
  61
  62     enum e_type { FG_BOOL=0, FG_INT, FG_FLOAT, FG_DOUBLE, FG_STRING, FG_FIXED, FG_BYTE, FG_WORD };
  63
  64     typedef struct {
  65      // string name;
  66         string format;
  67         e_type type;
  68         double offset;
  69         double factor;
  70         double min, max;
  71         bool wrap;
  72         bool rel;
  73         SGPropertyNode_ptr prop;
  74     } _serial_prot;
  75
  76 private:
  77
  78     string file_name;
  79     string direction;
  80
  81     int length;
  82     char buf[ FG_MAX_MSG_SIZE ];
  83
  84     string preamble;
  85     string postamble;
  86     string var_separator;
  87     string line_separator;
  88     string var_sep_string;
  89     string line_sep_string;
  90     vector<_serial_prot> _out_message;
  91     vector<_serial_prot> _in_message;
  92
  93     bool binary_mode;
  94     enum {FOOTER_NONE, FOOTER_LENGTH, FOOTER_MAGIC} binary_footer_type;
  95     int binary_footer_value;
  96     int binary_record_length;
  97     enum {BYTE_ORDER_NEEDS_CONVERSION, BYTE_ORDER_MATCHES_NETWORK_ORDER} binary_byte_order;
  98
  99     bool gen_message_ascii();
 100     bool gen_message_binary();
 101     bool parse_message_ascii(int length);
 102     bool parse_message_binary(int length);
 103     bool read_config(SGPropertyNode *root, vector<_serial_prot> &msg);
 104     bool exitOnError;
 105     bool initOk;
 106
 107     class FGProtocolWrapper * wrapper;
 108
 109     template<class T>
 110     static void updateValue(_serial_prot& prot, const T& val)
 111     {
 112       T new_val = (prot.rel ? getValue<T>(prot.prop) : 0)
 113                 + prot.offset
 114                 + prot.factor * val;
 115
 116       if( prot.max > prot.min )
 117       {
 118         if( prot.wrap )
 119           new_val = SGMisc<double>::normalizePeriodic(prot.min, prot.max, new_val);
 120         else
 121           new_val = SGMisc<T>::clip(new_val, prot.min, prot.max);
 122       }
 123
 124       setValue(prot.prop, new_val);
 125     }
 126
 127     // Special handling for bool (relative change = toggle, no min/max, no wrap)
 128     static void updateValue(_serial_prot& prot, bool val);
 129 };
 130
 131
 132 #endif // _FG_SERIAL_HXX
 133
 134