1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7 ------------- Copyright (C) 1999 Jon S. Berndt (jon@jsbsim.org) -------------
9 This program is free software; you can redistribute it and/or modify it under
10 the terms of the GNU Lesser General Public License as published by the Free Software
11 Foundation; either version 2 of the License, or (at your option) any later
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 Lesser General Public License for more
19 You should have received a copy of the GNU Lesser 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.
23 Further information about the GNU Lesser General Public License can also be found on
24 the world wide web at http://www.gnu.org.
27 --------------------------------------------------------------------------------
29 11/09/07 HDW Added FlightGear Socket Interface
31 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
38 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
46 #include "input_output/FGXMLFileRead.h"
47 #include "input_output/net_fdm.hxx"
49 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
51 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
53 #define ID_OUTPUT "$Id$"
55 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
63 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
67 /** Handles simulation output.
68 OUTPUT section definition
70 The following specifies the way that JSBSim writes out data.
72 NAME is the filename you want the output to go to
75 CSV Comma separated data. If a filename is supplied then the
76 data goes to that file. If "COUT" or "cout" is specified, the
77 data goes to stdout. If the filename is a null filename the
78 data goes to stdout, as well.
79 SOCKET Will eventually send data to a socket output, where NAME
80 would then be the IP address of the machine the data should
81 be sent to. DON'T USE THIS YET!
82 FLIGHTGEAR A socket is created for sending binary data packets to
83 an external instance of FlightGear for visuals. Parameters
84 defining the socket are given on the \<output> line.
85 TABULAR Columnar data.
86 TERMINAL Output to terminal. NOT IMPLEMENTED YET!
87 NONE Specifies to do nothing. This setting makes it easy to turn on and
88 off the data output without having to mess with anything else.
93 <output name="localhost" type="FLIGHTGEAR" port="5500" protocol="tcp" rate="10"/>
96 <output name="B737_datalog.csv" type="CSV" rate="20">
97 <property> velocities/vc-kts </property>
98 <velocities> ON </velocities>
103 The arguments that can be supplied, currently, are:
105 RATE_IN_HZ An integer rate in times-per-second that the data is output. This
106 value may not be *exactly* what you want, due to the dependence
107 on dt, the cycle rate for the FDM.
109 The following parameters tell which subsystems of data to output:
121 ground_reactions ON|OFF
125 NOTE that Time is always output with the data.
129 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
131 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
133 class FGOutput : public FGModel, public FGXMLFileRead
136 FGOutput(FGFDMExec*);
139 bool InitModel(void);
142 void DelimitedOutput(const std::string&);
143 void SocketOutput(void);
144 void FlightGearSocketOutput(void);
145 void SocketStatusOutput(const std::string&);
146 void SocketDataFill(FGNetFDM* net);
149 void SetType(const std::string& type);
150 void SetStartNewFile(bool tt) {StartNewFile = tt;}
151 void SetSubsystems(int tt) {SubSystems = tt;}
152 void Enable(void) { enabled = true; }
153 void Disable(void) { enabled = false; }
154 bool Toggle(void) {enabled = !enabled; return enabled;}
155 bool Load(Element* el);
156 void SetOutputFileName(const std::string& fname) {Filename = fname;}
157 void SetDirectivesFile(const std::string& fname) {DirectivesFile = fname;}
158 void SetRate(int rt);
159 string GetOutputFileName(void) const {return Filename;}
161 /// Subsystem types for specifying which will be output in the FDM data logging
163 /** Subsystem: Simulation (= 1) */ ssSimulation = 1,
164 /** Subsystem: Aerosurfaces (= 2) */ ssAerosurfaces = 2,
165 /** Subsystem: Body rates (= 4) */ ssRates = 4,
166 /** Subsystem: Velocities (= 8) */ ssVelocities = 8,
167 /** Subsystem: Forces (= 16) */ ssForces = 16,
168 /** Subsystem: Moments (= 32) */ ssMoments = 32,
169 /** Subsystem: Atmosphere (= 64) */ ssAtmosphere = 64,
170 /** Subsystem: Mass Properties (= 128) */ ssMassProps = 128,
171 /** Subsystem: Coefficients (= 256) */ ssCoefficients = 256,
172 /** Subsystem: Propagate (= 512) */ ssPropagate = 512,
173 /** Subsystem: Ground Reactions (= 1024) */ ssGroundReactions = 1024,
174 /** Subsystem: FCS (= 2048) */ ssFCS = 2048,
175 /** Subsystem: Propulsion (= 4096) */ ssPropulsion = 4096
182 enum {otNone, otCSV, otTab, otSocket, otTerminal, otFlightGear, otUnknown} Type;
183 bool sFirstPass, dFirstPass, enabled;
187 std::string output_file_name, delimeter, BaseFilename, Filename, DirectivesFile;
188 std::ofstream datafile;
190 FGfdmSocket* flightGearSocket;
191 std::vector <FGPropertyManager*> OutputProperties;
193 void Debug(int from);
196 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%