src/FDM/JSBSim/FGOutput.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGOutput.h
   4  Author:       Jon Berndt
   5  Date started: 12/2/98
   6
   7  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU General Public License as published by the Free Software
  11  Foundation; either version 2 of the License, or (at your option) any later
  12  version.
  13
  14  This program is distributed in the hope that it will be useful, but WITHOUT
  15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU General Public License along with
  20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  21  Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23  Further information about the GNU General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 HISTORY
  27 --------------------------------------------------------------------------------
  28 12/02/98   JSB   Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGOUTPUT_H
  35 #define FGOUTPUT_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGModel.h"
  42
  43 #ifdef FGFS
  44 #  include <simgear/compiler.h>
  45 #  include STL_IOSTREAM
  46 #  include STL_FSTREAM
  47 #else
  48 #  if defined(sgi) && !defined(__GNUC__) && (_COMPILER_VERSION < 740)
  49 #    include <iostream.h>
  50 #    include <fstream.h>
  51 #  else
  52 #    include <iostream>
  53 #    include <fstream>
  54 #  endif
  55 #endif
  56
  57 #include "FGfdmSocket.h"
  58
  59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  60 DEFINITIONS
  61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  62
  63 #define ID_OUTPUT "$Id$"
  64
  65 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  66 FORWARD DECLARATIONS
  67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  68
  69 namespace JSBSim {
  70
  71 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  72 CLASS DOCUMENTATION
  73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  74
  75 /** Handles simulation output.
  76   */
  77
  78 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  79 CLASS DECLARATION
  80 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  81
  82 class FGOutput : public FGModel
  83 {
  84 public:
  85   FGOutput(FGFDMExec*);
  86   ~FGOutput();
  87
  88   bool Run(void);
  89
  90   void DelimitedOutput(string);
  91   void SocketOutput(void);
  92   void SocketStatusOutput(string);
  93   void SetFilename(string fn) {Filename = fn;}
  94   void SetType(string);
  95   void SetSubsystems(int tt) {SubSystems = tt;}
  96   inline void Enable(void) { enabled = true; }
  97   inline void Disable(void) { enabled = false; }
  98   inline bool Toggle(void) {enabled = !enabled; return enabled;}
  99   bool Load(FGConfigFile* AC_cfg);
 100
 101   /// Subsystem types for specifying which will be output in the FDM data logging
 102   enum  eSubSystems {
 103     /** Subsystem: Simulation (= 1)          */ ssSimulation      = 1,
 104     /** Subsystem: Aerosurfaces (= 2)        */ ssAerosurfaces    = 2,
 105     /** Subsystem: Body rates (= 4)          */ ssRates           = 4,
 106     /** Subsystem: Velocities (= 8)          */ ssVelocities      = 8,
 107     /** Subsystem: Forces (= 16)             */ ssForces          = 16,
 108     /** Subsystem: Moments (= 32)            */ ssMoments         = 32,
 109     /** Subsystem: Atmosphere (= 64)         */ ssAtmosphere      = 64,
 110     /** Subsystem: Mass Properties (= 128)   */ ssMassProps       = 128,
 111     /** Subsystem: Coefficients (= 256)      */ ssCoefficients    = 256,
 112     /** Subsystem: Position (= 512)          */ ssPosition        = 512,
 113     /** Subsystem: Ground Reactions (= 1024) */ ssGroundReactions = 1024,
 114     /** Subsystem: FCS (= 2048)              */ ssFCS             = 2048,
 115     /** Subsystem: Propulsion (= 4096)       */ ssPropulsion      = 4096
 116   } subsystems;
 117
 118 private:
 119   bool sFirstPass, dFirstPass, enabled;
 120   int SubSystems;
 121   string Filename, outputInFileName;
 122   enum {otNone, otCSV, otTab, otSocket, otTerminal, otUnknown} Type;
 123   ofstream datafile;
 124   FGfdmSocket* socket;
 125   vector <FGPropertyManager*> OutputProperties;
 126   void Debug(int from);
 127 };
 128 }
 129 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 130 #endif
 131