JSBSim Flight Dynamics Model  1.1.11 (13 Feb 2022)
An Open Source Flight Dynamics and Control Software Library in C++
FGOutputTextFile.cpp
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 
3  Module: FGOutputTextFile.cpp
4  Author: Bertrand Coconnier
5  Date started: 09/17/11
6  Purpose: Manage output of sim parameters to a text file
7  Called by: FGOutput
8 
9  ------------- Copyright (C) 2011 Bertrand Coconnier -------------
10 
11  This program is free software; you can redistribute it and/or modify it under
12  the terms of the GNU Lesser General Public License as published by the Free
13  Software Foundation; either version 2 of the License, or (at your option) any
14  later version.
15 
16  This program is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18  FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
19  details.
20 
21  You should have received a copy of the GNU Lesser General Public License along
22  with this program; if not, write to the Free Software Foundation, Inc., 59
23  Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 
25  Further information about the GNU Lesser General Public License can also be
26  found on the world wide web at http://www.gnu.org.
27 
28 FUNCTIONAL DESCRIPTION
29 --------------------------------------------------------------------------------
30 This is the place where you create output routines to dump data for perusal
31 later.
32 
33 HISTORY
34 --------------------------------------------------------------------------------
35 09/17/11 BC Created
36 
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 INCLUDES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40 
41 #include <iomanip>
42 
43 #include "FGOutputTextFile.h"
44 #include "models/FGAerodynamics.h"
45 #include "models/FGAccelerations.h"
46 #include "models/FGAtmosphere.h"
47 #include "models/FGAuxiliary.h"
48 #include "models/FGPropulsion.h"
49 #include "models/FGMassBalance.h"
50 #include "models/FGExternalReactions.h"
51 #include "models/FGBuoyantForces.h"
52 #include "models/FGFCS.h"
53 #include "models/atmosphere/FGWinds.h"
54 #include "input_output/FGXMLElement.h"
55 
56 using namespace std;
57 
58 namespace JSBSim {
59 
60 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
61 CLASS IMPLEMENTATION
62 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
63 
64 bool FGOutputTextFile::Load(Element* el)
65 {
66  if(!FGOutputFile::Load(el))
67  return false;
68 
69  string type = el->GetAttributeValue("type");
70  string delim;
71  if (type == "TABULAR") {
72  delim = "\t";
73  } else {
74  delim = ",";
75  }
76 
77  SetDelimiter(delim);
78 
79  return true;
80 }
81 
82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
83 
84 bool FGOutputTextFile::OpenFile(void)
85 {
86  datafile.clear();
87  datafile.open(Filename);
88  if (!datafile) {
89  cerr << endl << fgred << highint << "ERROR: unable to open the file "
90  << reset << Filename.c_str() << endl
91  << fgred << highint << " => Output to this file is disabled."
92  << reset << endl << endl;
93  Disable();
94  return false;
95  }
96 
97  string scratch = "";
98  streambuf* buffer = datafile.rdbuf();
99  ostream outstream(buffer);
100 
101  outstream.precision(10);
102 
103  outstream << "Time";
104  if (SubSystems & ssSimulation) {
105  // Nothing here, yet
106  }
107  if (SubSystems & ssAerosurfaces) {
108  outstream << delimeter;
109  outstream << "Aileron Command (norm)" + delimeter;
110  outstream << "Elevator Command (norm)" + delimeter;
111  outstream << "Rudder Command (norm)" + delimeter;
112  outstream << "Flap Command (norm)" + delimeter;
113  outstream << "Left Aileron Position (deg)" + delimeter;
114  outstream << "Right Aileron Position (deg)" + delimeter;
115  outstream << "Elevator Position (deg)" + delimeter;
116  outstream << "Rudder Position (deg)" + delimeter;
117  outstream << "Flap Position (deg)";
118  }
119  if (SubSystems & ssRates) {
120  outstream << delimeter;
121  outstream << "P (deg/s)" + delimeter + "Q (deg/s)" + delimeter + "R (deg/s)" + delimeter;
122  outstream << "P dot (deg/s^2)" + delimeter + "Q dot (deg/s^2)" + delimeter + "R dot (deg/s^2)" + delimeter;
123  outstream << "P_{inertial} (deg/s)" + delimeter + "Q_{inertial} (deg/s)" + delimeter + "R_{inertial} (deg/s)";
124  }
125  if (SubSystems & ssVelocities) {
126  outstream << delimeter;
127  outstream << "q bar (psf)" + delimeter;
128  outstream << "Reynolds Number" + delimeter;
129  outstream << "V_{Total} (ft/s)" + delimeter;
130  outstream << "V_{Inertial} (ft/s)" + delimeter;
131  outstream << "UBody" + delimeter + "VBody" + delimeter + "WBody" + delimeter;
132  outstream << "UdotBody" + delimeter + "VdotBody" + delimeter + "WdotBody" + delimeter;
133  outstream << "UdotBody_i" + delimeter + "VdotBody_i" + delimeter + "WdotBody_i" + delimeter;
134  outstream << "BodyAccel_X" + delimeter + "BodyAccel_Y" + delimeter + "BodyAccel_Z" + delimeter;
135  outstream << "Aero V_{X Body} (ft/s)" + delimeter + "Aero V_{Y Body} (ft/s)" + delimeter + "Aero V_{Z Body} (ft/s)" + delimeter;
136  outstream << "V_{X_{inertial}} (ft/s)" + delimeter + "V_{Y_{inertial}} (ft/s)" + delimeter + "V_{Z_{inertial}} (ft/s)" + delimeter;
137  outstream << "V_{X_{ecef}} (ft/s)" + delimeter + "V_{Y_{ecef}} (ft/s)" + delimeter + "V_{Z_{ecef}} (ft/s)" + delimeter;
138  outstream << "V_{North} (ft/s)" + delimeter + "V_{East} (ft/s)" + delimeter + "V_{Down} (ft/s)";
139  }
140  if (SubSystems & ssForces) {
141  outstream << delimeter;
142  outstream << "F_{Drag} (lbs)" + delimeter + "F_{Side} (lbs)" + delimeter + "F_{Lift} (lbs)" + delimeter;
143  outstream << "L/D" + delimeter;
144  outstream << "F_{Aero x} (lbs)" + delimeter + "F_{Aero y} (lbs)" + delimeter + "F_{Aero z} (lbs)" + delimeter;
145  outstream << "F_{Prop x} (lbs)" + delimeter + "F_{Prop y} (lbs)" + delimeter + "F_{Prop z} (lbs)" + delimeter;
146  outstream << "F_{Gear x} (lbs)" + delimeter + "F_{Gear y} (lbs)" + delimeter + "F_{Gear z} (lbs)" + delimeter;
147  outstream << "F_{Ext x} (lbs)" + delimeter + "F_{Ext y} (lbs)" + delimeter + "F_{Ext z} (lbs)" + delimeter;
148  outstream << "F_{Buoyant x} (lbs)" + delimeter + "F_{Buoyant y} (lbs)" + delimeter + "F_{Buoyant z} (lbs)" + delimeter;
149  outstream << "F_{Weight x} (lbs)" + delimeter + "F_{Weight y} (lbs)" + delimeter + "F_{Weight z} (lbs)" + delimeter;
150  outstream << "F_{Total x} (lbs)" + delimeter + "F_{Total y} (lbs)" + delimeter + "F_{Total z} (lbs)";
151  }
152  if (SubSystems & ssMoments) {
153  outstream << delimeter;
154  outstream << "L_{Aero} (ft-lbs)" + delimeter + "M_{Aero} (ft-lbs)" + delimeter + "N_{Aero} (ft-lbs)" + delimeter;
155  outstream << "L_{Aero MRC} (ft-lbs)" + delimeter + "M_{Aero MRC} (ft-lbs)" + delimeter + "N_{Aero MRC} (ft-lbs)" + delimeter;
156  outstream << "L_{Prop} (ft-lbs)" + delimeter + "M_{Prop} (ft-lbs)" + delimeter + "N_{Prop} (ft-lbs)" + delimeter;
157  outstream << "L_{Gear} (ft-lbs)" + delimeter + "M_{Gear} (ft-lbs)" + delimeter + "N_{Gear} (ft-lbs)" + delimeter;
158  outstream << "L_{ext} (ft-lbs)" + delimeter + "M_{ext} (ft-lbs)" + delimeter + "N_{ext} (ft-lbs)" + delimeter;
159  outstream << "L_{Buoyant} (ft-lbs)" + delimeter + "M_{Buoyant} (ft-lbs)" + delimeter + "N_{Buoyant} (ft-lbs)" + delimeter;
160  outstream << "L_{Total} (ft-lbs)" + delimeter + "M_{Total} (ft-lbs)" + delimeter + "N_{Total} (ft-lbs)";
161  }
162  if (SubSystems & ssAtmosphere) {
163  outstream << delimeter;
164  outstream << "Rho (slugs/ft^3)" + delimeter;
165  outstream << "Absolute Viscosity" + delimeter;
166  outstream << "Kinematic Viscosity" + delimeter;
167  outstream << "Temperature (R)" + delimeter;
168  outstream << "P_{SL} (psf)" + delimeter;
169  outstream << "P_{Ambient} (psf)" + delimeter;
170  outstream << "Turbulence Magnitude (ft/sec)" + delimeter;
171  outstream << "Turbulence X Direction (deg)" + delimeter;
172  outstream << "Wind V_{North} (ft/s)" + delimeter + "Wind V_{East} (ft/s)" + delimeter + "Wind V_{Down} (ft/s)" + delimeter;
173  outstream << "Roll Turbulence (deg/sec)" + delimeter + "Pitch Turbulence (deg/sec)" + delimeter + "Yaw Turbulence (deg/sec)";
174  }
175  if (SubSystems & ssMassProps) {
176  outstream << delimeter;
177  outstream << "I_{xx}" + delimeter;
178  outstream << "I_{xy}" + delimeter;
179  outstream << "I_{xz}" + delimeter;
180  outstream << "I_{yx}" + delimeter;
181  outstream << "I_{yy}" + delimeter;
182  outstream << "I_{yz}" + delimeter;
183  outstream << "I_{zx}" + delimeter;
184  outstream << "I_{zy}" + delimeter;
185  outstream << "I_{zz}" + delimeter;
186  outstream << "Mass" + delimeter;
187  outstream << "Weight" + delimeter;
188  outstream << "X_{cg}" + delimeter + "Y_{cg}" + delimeter + "Z_{cg}";
189  }
190  if (SubSystems & ssPropagate) {
191  outstream << delimeter;
192  outstream << "Altitude ASL (ft)" + delimeter;
193  outstream << "Altitude AGL (ft)" + delimeter;
194  outstream << "Phi (deg)" + delimeter + "Theta (deg)" + delimeter + "Psi (deg)" + delimeter;
195  outstream << "Q(1)_{LOCAL}" + delimeter + "Q(2)_{LOCAL}" + delimeter + "Q(3)_{LOCAL}" + delimeter + "Q(4)_{LOCAL}" + delimeter;
196  outstream << "Q(1)_{ECEF}" + delimeter + "Q(2)_{ECEF}" + delimeter + "Q(3)_{ECEF}" + delimeter + "Q(4)_{ECEF}" + delimeter;
197  outstream << "Q(1)_{ECI}" + delimeter + "Q(2)_{ECI}" + delimeter + "Q(3)_{ECI}" + delimeter + "Q(4)_{ECI}" + delimeter;
198  outstream << "Alpha (deg)" + delimeter;
199  outstream << "Beta (deg)" + delimeter;
200  outstream << "Latitude (deg)" + delimeter;
201  outstream << "Latitude Geodetic (deg)" + delimeter;
202  outstream << "Longitude (deg)" + delimeter;
203  outstream << "X_{ECI} (ft)" + delimeter + "Y_{ECI} (ft)" + delimeter + "Z_{ECI} (ft)" + delimeter;
204  outstream << "X_{ECEF} (ft)" + delimeter + "Y_{ECEF} (ft)" + delimeter + "Z_{ECEF} (ft)" + delimeter;
205  outstream << "Earth Position Angle (deg)" + delimeter;
206  outstream << "Distance AGL (ft)" + delimeter;
207  outstream << "Terrain Elevation (ft)";
208  }
209  if (SubSystems & ssAeroFunctions) {
210  scratch = Aerodynamics->GetAeroFunctionStrings(delimeter);
211  if (scratch.length() != 0) outstream << delimeter << scratch;
212  }
213  if (SubSystems & ssFCS) {
214  scratch = FCS->GetComponentStrings(delimeter);
215  if (scratch.length() != 0) outstream << delimeter << scratch;
216  }
217  if (SubSystems & ssGroundReactions) {
218  outstream << delimeter;
219  outstream << GroundReactions->GetGroundReactionStrings(delimeter);
220  }
221  if (SubSystems & ssPropulsion && Propulsion->GetNumEngines() > 0) {
222  outstream << delimeter;
223  outstream << Propulsion->GetPropulsionStrings(delimeter);
224  }
225 
226  for (unsigned int i=0;i<OutputParameters.size();++i) {
227  if (!OutputCaptions[i].empty())
228  outstream << delimeter << OutputCaptions[i];
229  else
230  outstream << delimeter << OutputParameters[i]->GetFullyQualifiedName();
231  }
232 
233  if (PreFunctions.size() > 0) {
234  for (unsigned int i=0;i<PreFunctions.size();i++) {
235  outstream << delimeter << PreFunctions[i]->GetName();
236  }
237  }
238 
239  outstream << endl;
240  outstream.flush();
241 
242  return true;
243 }
244 
245 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
246 
247 void FGOutputTextFile::Print(void)
248 {
249  streambuf* buffer;
250  string scratch = Filename.utf8Str();
251 
252  if (to_upper(scratch) == "COUT") {
253  buffer = cout.rdbuf();
254  } else {
255  buffer = datafile.rdbuf();
256  }
257 
258  ostream outstream(buffer);
259 
260  outstream.precision(10);
261 
262  outstream << FDMExec->GetSimTime();
263  if (SubSystems & ssSimulation) {
264  }
265  if (SubSystems & ssAerosurfaces) {
266  outstream << delimeter;
267  outstream << FCS->GetDaCmd() << delimeter;
268  outstream << FCS->GetDeCmd() << delimeter;
269  outstream << FCS->GetDrCmd() << delimeter;
270  outstream << FCS->GetDfCmd() << delimeter;
271  outstream << FCS->GetDaLPos(ofDeg) << delimeter;
272  outstream << FCS->GetDaRPos(ofDeg) << delimeter;
273  outstream << FCS->GetDePos(ofDeg) << delimeter;
274  outstream << FCS->GetDrPos(ofDeg) << delimeter;
275  outstream << FCS->GetDfPos(ofDeg);
276  }
277  if (SubSystems & ssRates) {
278  outstream << delimeter;
279  outstream << (radtodeg*Propagate->GetPQR()).Dump(delimeter) << delimeter;
280  outstream << (radtodeg*Accelerations->GetPQRdot()).Dump(delimeter) << delimeter;
281  outstream << (radtodeg*Propagate->GetPQRi()).Dump(delimeter);
282  }
283  if (SubSystems & ssVelocities) {
284  outstream << delimeter;
285  outstream << Auxiliary->Getqbar() << delimeter;
286  outstream << Auxiliary->GetReynoldsNumber() << delimeter;
287  outstream << setprecision(12) << Auxiliary->GetVt() << delimeter;
288  outstream << Propagate->GetInertialVelocityMagnitude() << delimeter;
289  outstream << setprecision(12) << Propagate->GetUVW().Dump(delimeter) << delimeter;
290  outstream << setprecision(12) << Accelerations->GetUVWdot().Dump(delimeter) << delimeter;
291  outstream << setprecision(12) << Accelerations->GetUVWidot().Dump(delimeter) << delimeter;
292  outstream << setprecision(12) << Accelerations->GetBodyAccel().Dump(delimeter) << delimeter;
293  outstream << Auxiliary->GetAeroUVW().Dump(delimeter) << delimeter;
294  outstream << Propagate->GetInertialVelocity().Dump(delimeter) << delimeter;
295  outstream << Propagate->GetECEFVelocity().Dump(delimeter) << delimeter;
296  outstream << Propagate->GetVel().Dump(delimeter);
297  outstream.precision(10);
298  }
299  if (SubSystems & ssForces) {
300  outstream << delimeter;
301  outstream << Aerodynamics->GetvFw().Dump(delimeter) << delimeter;
302  outstream << Aerodynamics->GetLoD() << delimeter;
303  outstream << Aerodynamics->GetForces().Dump(delimeter) << delimeter;
304  outstream << Propulsion->GetForces().Dump(delimeter) << delimeter;
305  outstream << Accelerations->GetGroundForces().Dump(delimeter) << delimeter;
306  outstream << ExternalReactions->GetForces().Dump(delimeter) << delimeter;
307  outstream << BuoyantForces->GetForces().Dump(delimeter) << delimeter;
308  outstream << Accelerations->GetWeight().Dump(delimeter) << delimeter;
309  outstream << Accelerations->GetForces().Dump(delimeter);
310  }
311  if (SubSystems & ssMoments) {
312  outstream << delimeter;
313  outstream << Aerodynamics->GetMoments().Dump(delimeter) << delimeter;
314  outstream << Aerodynamics->GetMomentsMRC().Dump(delimeter) << delimeter;
315  outstream << Propulsion->GetMoments().Dump(delimeter) << delimeter;
316  outstream << Accelerations->GetGroundMoments().Dump(delimeter) << delimeter;
317  outstream << ExternalReactions->GetMoments().Dump(delimeter) << delimeter;
318  outstream << BuoyantForces->GetMoments().Dump(delimeter) << delimeter;
319  outstream << Accelerations->GetMoments().Dump(delimeter);
320  }
321  if (SubSystems & ssAtmosphere) {
322  outstream << delimeter;
323  outstream << Atmosphere->GetDensity() << delimeter;
324  outstream << Atmosphere->GetAbsoluteViscosity() << delimeter;
325  outstream << Atmosphere->GetKinematicViscosity() << delimeter;
326  outstream << Atmosphere->GetTemperature() << delimeter;
327  outstream << Atmosphere->GetPressureSL() << delimeter;
328  outstream << Atmosphere->GetPressure() << delimeter;
329  outstream << Winds->GetTurbMagnitude() << delimeter;
330  outstream << Winds->GetTurbDirection() << delimeter;
331  outstream << Winds->GetTotalWindNED().Dump(delimeter) << delimeter;
332  outstream << (Winds->GetTurbPQR()*radtodeg).Dump(delimeter);
333  }
334  if (SubSystems & ssMassProps) {
335  outstream << delimeter;
336  outstream << MassBalance->GetJ().Dump(delimeter) << delimeter;
337  outstream << MassBalance->GetMass() << delimeter;
338  outstream << MassBalance->GetWeight() << delimeter;
339  outstream << MassBalance->GetXYZcg().Dump(delimeter);
340  }
341  if (SubSystems & ssPropagate) {
342  outstream.precision(14);
343  outstream << delimeter;
344  outstream << Propagate->GetAltitudeASL() << delimeter;
345  outstream << Propagate->GetDistanceAGL() << delimeter;
346  outstream << (radtodeg*Propagate->GetEuler()).Dump(delimeter) << delimeter;
347  outstream << Propagate->GetQuaternion().Dump(delimeter) << delimeter;
348  FGQuaternion Qec = Propagate->GetQuaternionECEF();
349  outstream << Qec.Dump(delimeter) << delimeter;
350  outstream << Propagate->GetQuaternionECI().Dump(delimeter) << delimeter;
351  outstream << Auxiliary->Getalpha(inDegrees) << delimeter;
352  outstream << Auxiliary->Getbeta(inDegrees) << delimeter;
353  outstream << Propagate->GetLatitudeDeg() << delimeter;
354  outstream << Propagate->GetGeodLatitudeDeg() << delimeter;
355  outstream << Propagate->GetLongitudeDeg() << delimeter;
356  outstream.precision(18);
357  outstream << ((FGColumnVector3)Propagate->GetInertialPosition()).Dump(delimeter) << delimeter;
358  outstream << ((FGColumnVector3)Propagate->GetLocation()).Dump(delimeter) << delimeter;
359  outstream.precision(14);
360  outstream << Propagate->GetEarthPositionAngleDeg() << delimeter;
361  outstream << Propagate->GetDistanceAGL() << delimeter;
362  outstream << Propagate->GetTerrainElevation();
363  outstream.precision(10);
364  }
365  if (SubSystems & ssAeroFunctions) {
366  scratch = Aerodynamics->GetAeroFunctionValues(delimeter);
367  if (scratch.length() != 0) outstream << delimeter << scratch;
368  }
369  if (SubSystems & ssFCS) {
370  scratch = FCS->GetComponentValues(delimeter);
371  if (scratch.length() != 0) outstream << delimeter << scratch;
372  }
373  if (SubSystems & ssGroundReactions) {
374  outstream << delimeter;
375  outstream << GroundReactions->GetGroundReactionValues(delimeter);
376  }
377  if (SubSystems & ssPropulsion && Propulsion->GetNumEngines() > 0) {
378  outstream << delimeter;
379  outstream << Propulsion->GetPropulsionValues(delimeter);
380  }
381 
382  outstream.precision(18);
383  for (unsigned int i=0;i<OutputParameters.size();++i) {
384  outstream << delimeter << OutputParameters[i]->GetValue();
385  }
386  for (unsigned int i=0;i<PreFunctions.size();i++) {
387  outstream << delimeter << PreFunctions[i]->getDoubleValue();
388  }
389  outstream.precision(10);
390 
391  outstream << endl;
392  outstream.flush();
393 }
394 }
JSBSim::FGColumnVector3
This class implements a 3 element column vector.
Definition: FGColumnVector3.h:63
JSBSim::Element::GetAttributeValue
std::string GetAttributeValue(const std::string &key)
Retrieves an attribute.
Definition: FGXMLElement.cpp:260
JSBSim::FGFDMExec::GetSimTime
double GetSimTime(void) const
Returns the cumulative simulation time in seconds.
Definition: FGFDMExec.h:542
JSBSim::FGQuaternion
Models the Quaternion representation of rotations.
Definition: FGQuaternion.h:86
JSBSim::Element
Definition: FGXMLElement.h:143