src/FDM/JSBSim/FGOutput.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGOutput.cpp
   4  Author:       Jon Berndt
   5  Date started: 12/02/98
   6  Purpose:      Manage output of sim parameters to file or stdout
   7  Called by:    FGSimExec
   8
   9  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
  10
  11  This program is free software; you can redistribute it and/or modify it under
  12  the terms of the GNU General Public License as published by the Free Software
  13  Foundation; either version 2 of the License, or (at your option) any later
  14  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 General Public License for more
  19  details.
  20
  21  You should have received a copy of the GNU General Public License along with
  22  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  23  Place - Suite 330, Boston, MA  02111-1307, USA.
  24
  25  Further information about the GNU General Public License can also be found on
  26  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 12/02/98   JSB   Created
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGOutput.h"
  42 #include "FGState.h"
  43 #include "FGFDMExec.h"
  44 #include "FGAtmosphere.h"
  45 #include "FGFCS.h"
  46 #include "FGAircraft.h"
  47 #include "FGTranslation.h"
  48 #include "FGRotation.h"
  49 #include "FGPosition.h"
  50 #include "FGAuxiliary.h"
  51
  52 static const char *IdSrc = "$Id$";
  53 static const char *IdHdr = ID_OUTPUT;
  54
  55 extern short debug_lvl;
  56
  57 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  58 CLASS IMPLEMENTATION
  59 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  60
  61 FGOutput::FGOutput(FGFDMExec* fdmex) : FGModel(fdmex)
  62 {
  63   Name = "FGOutput";
  64   sFirstPass = dFirstPass = true;
  65   socket = 0;
  66   Type = otNone;
  67   Filename = "JSBSim.out";
  68   SubSystems = 0;
  69   enabled = true;
  70
  71 #ifdef FG_WITH_JSBSIM_SOCKET
  72   socket = new FGfdmSocket("localhost",1138);
  73 #endif
  74   if (debug_lvl & 2) cout << "Instantiated: " << Name << endl;
  75 }
  76
  77 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  78
  79 FGOutput::~FGOutput()
  80 {
  81   if (socket) delete socket;
  82   if (debug_lvl & 2) cout << "Destroyed:    FGOutput" << endl;
  83 }
  84
  85 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  86
  87 bool FGOutput::Run(void)
  88 {
  89   if (enabled) {
  90     if (!FGModel::Run()) {
  91
  92       if (Type == otSocket) {
  93         SocketOutput();
  94       } else if (Type == otCSV) {
  95         if (Filename != "COUT" && Filename != "cout" && Filename.size() > 0) {
  96           DelimitedOutput(Filename);
  97         } else {
  98           DelimitedOutput();
  99         }
 100       } else if (Type == otTerminal) {
 101         // Not done yet
 102       } else if (Type == otNone) {
 103         // Do nothing
 104       } else {
 105         // Not a valid type of output
 106       }
 107
 108     } else {
 109     }
 110   }
 111   return false;
 112 }
 113
 114 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 115
 116 void FGOutput::SetType(string type)
 117 {
 118   if (type == "CSV") {
 119     Type = otCSV;
 120   } else if (type == "TABULAR") {
 121     Type = otTab;
 122   } else if (type == "SOCKET") {
 123     Type = otSocket;
 124   } else if (type == "TERMINAL") {
 125     Type = otTerminal;
 126   } else if (type != "NONE"){
 127     Type = otUnknown;
 128     cerr << "Unknown type of output specified in config file" << endl;
 129   }
 130 }
 131
 132 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 133
 134 void FGOutput::DelimitedOutput(void)
 135 {
 136   if (dFirstPass) {
 137     cout << "Time";
 138     if (SubSystems & FGAircraft::ssSimulation) {
 139       // Nothing here, yet
 140     }
 141     if (SubSystems & FGAircraft::ssAerosurfaces) {
 142       cout << ", ";
 143       cout << "Throttle, ";
 144       cout << "Aileron Cmd, ";
 145       cout << "Elevator Cmd, ";
 146       cout << "Rudder Cmd, ";
 147       cout << "Aileron Pos, ";
 148       cout << "Elevator Pos, ";
 149       cout << "Rudder Pos";
 150     }
 151     if (SubSystems & FGAircraft::ssRates) {
 152       cout << ", ";
 153       cout << "P, Q, R";
 154     }
 155     if (SubSystems & FGAircraft::ssVelocities) {
 156       cout << ", ";
 157       cout << "QBar, ";
 158       cout << "Vtotal, ";
 159       cout << "U, V, W, ";
 160       cout << "Vn, Ve, Vd";
 161     }
 162     if (SubSystems & FGAircraft::ssForces) {
 163       cout << ", ";
 164       cout << "XsForce, YsForce, ZsForce, ";
 165       cout << "Xforce, Yforce, Zforce";
 166     }
 167     if (SubSystems & FGAircraft::ssMoments) {
 168       cout << ", ";
 169       cout << "L, M, N";
 170     }
 171     if (SubSystems & FGAircraft::ssAtmosphere) {
 172       cout << ", ";
 173       cout << "Rho";
 174     }
 175     if (SubSystems & FGAircraft::ssMassProps) {
 176       cout << ", ";
 177       cout << "Ixx, ";
 178       cout << "Iyy, ";
 179       cout << "Izz, ";
 180       cout << "Ixz, ";
 181       cout << "Mass, ";
 182       cout << "Xcg, Ycg, Zcg";
 183     }
 184     if (SubSystems & FGAircraft::ssPosition) {
 185       cout << ", ";
 186       cout << "Altitude, ";
 187       cout << "Phi, Tht, Psi, ";
 188       cout << "Alpha, ";
 189       cout << "Latitude, ";
 190       cout << "Longitude, ";
 191       cout << "Distance AGL, ";
 192       cout << "Runway Radius";
 193     }
 194     if (SubSystems & FGAircraft::ssCoefficients) {
 195       cout << ", ";
 196       cout << Aircraft->GetCoefficientStrings();
 197     }
 198     if (SubSystems & FGAircraft::ssGroundReactions) {
 199       cout << ", ";
 200       cout << Aircraft->GetGroundReactionStrings();
 201     }
 202
 203     cout << endl;
 204     dFirstPass = false;
 205   }
 206
 207   cout << State->Getsim_time();
 208   if (SubSystems & FGAircraft::ssSimulation) {
 209   }
 210   if (SubSystems & FGAircraft::ssAerosurfaces) {
 211     cout << ", ";
 212     cout << FCS->GetThrottlePos(0) << ", ";
 213     cout << FCS->GetDaCmd() << ", ";
 214     cout << FCS->GetDeCmd() << ", ";
 215     cout << FCS->GetDrCmd() << ", ";
 216     cout << FCS->GetDaPos() << ", ";
 217     cout << FCS->GetDePos() << ", ";
 218     cout << FCS->GetDrPos();
 219   }
 220   if (SubSystems & FGAircraft::ssRates) {
 221     cout << ", ";
 222     cout << Rotation->GetPQR();
 223   }
 224   if (SubSystems & FGAircraft::ssVelocities) {
 225     cout << ", ";
 226     cout << Translation->Getqbar() << ", ";
 227     cout << Translation->GetVt() << ", ";
 228     cout << Translation->GetUVW() << ", ";
 229     cout << Position->GetVel();
 230   }
 231   if (SubSystems & FGAircraft::ssForces) {
 232     cout << ", ";
 233     cout << Aircraft->GetvFs() << ", ";
 234     cout << Aircraft->GetForces();
 235   }
 236   if (SubSystems & FGAircraft::ssMoments) {
 237     cout << ", ";
 238     cout << Aircraft->GetMoments();
 239   }
 240   if (SubSystems & FGAircraft::ssAtmosphere) {
 241     cout << ", ";
 242     cout << Atmosphere->GetDensity();
 243   }
 244   if (SubSystems & FGAircraft::ssMassProps) {
 245     cout << ", ";
 246     cout << Aircraft->GetIxx() << ", ";
 247     cout << Aircraft->GetIyy() << ", ";
 248     cout << Aircraft->GetIzz() << ", ";
 249     cout << Aircraft->GetIxz() << ", ";
 250     cout << Aircraft->GetMass() << ", ";
 251     cout << Aircraft->GetXYZcg();
 252   }
 253   if (SubSystems & FGAircraft::ssPosition) {
 254     cout << ", ";
 255     cout << Position->Geth() << ", ";
 256     cout << Rotation->GetEuler() << ", ";
 257     cout << Translation->Getalpha() << ", ";
 258     cout << Position->GetLatitude() << ", ";
 259     cout << Position->GetLongitude() << ", ";
 260     cout << Position->GetDistanceAGL() << ", ";
 261     cout << Position->GetRunwayRadius();
 262   }
 263   if (SubSystems & FGAircraft::ssCoefficients) {
 264     cout << ", ";
 265     cout << Aircraft->GetCoefficientValues();
 266   }
 267   if (SubSystems & FGAircraft::ssGroundReactions) {
 268     cout << ", ";
 269     cout << Aircraft->GetGroundReactionValues();
 270   }
 271   cout << endl;
 272 }
 273
 274 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 275
 276 void FGOutput::DelimitedOutput(string fname)
 277 {
 278   if (sFirstPass) {
 279     datafile.open(fname.c_str());
 280     datafile << "Time";
 281     if (SubSystems & FGAircraft::ssSimulation) {
 282       // Nothing here, yet
 283     }
 284     if (SubSystems & FGAircraft::ssAerosurfaces) {
 285       datafile << ", ";
 286       datafile << "Throttle, ";
 287       datafile << "Aileron Cmd, ";
 288       datafile << "Elevator Cmd, ";
 289       datafile << "Rudder Cmd, ";
 290       datafile << "Aileron Pos, ";
 291       datafile << "Elevator Pos, ";
 292       datafile << "Rudder Pos";
 293     }
 294     if (SubSystems & FGAircraft::ssRates) {
 295       datafile << ", ";
 296       datafile << "P, Q, R";
 297     }
 298     if (SubSystems & FGAircraft::ssVelocities) {
 299       datafile << ", ";
 300       datafile << "QBar, ";
 301       datafile << "Vtotal, ";
 302       datafile << "U, V, W, ";
 303       datafile << "Vn, Ve, Vd";
 304     }
 305     if (SubSystems & FGAircraft::ssForces) {
 306       datafile << ", ";
 307       datafile << "XsForce, YsForce, ZsForce, ";
 308       datafile << "Xforce, Yforce, Zforce";
 309     }
 310     if (SubSystems & FGAircraft::ssMoments) {
 311       datafile << ", ";
 312       datafile << "L, M, N";
 313     }
 314     if (SubSystems & FGAircraft::ssAtmosphere) {
 315       datafile << ", ";
 316       datafile << "Rho";
 317     }
 318     if (SubSystems & FGAircraft::ssMassProps) {
 319       datafile << ", ";
 320       datafile << "Ixx, ";
 321       datafile << "Iyy, ";
 322       datafile << "Izz, ";
 323       datafile << "Ixz, ";
 324       datafile << "Mass, ";
 325       datafile << "Xcg, Ycg, Zcg";
 326     }
 327     if (SubSystems & FGAircraft::ssPosition) {
 328       datafile << ", ";
 329       datafile << "Altitude, ";
 330       datafile << "Phi, Tht, Psi, ";
 331       datafile << "Alpha, ";
 332       datafile << "Latitude, ";
 333       datafile << "Longitude, ";
 334       datafile << "Distance AGL, ";
 335       datafile << "Runway Radius";
 336     }
 337     if (SubSystems & FGAircraft::ssCoefficients) {
 338       datafile << ", ";
 339       datafile << Aircraft->GetCoefficientStrings();
 340     }
 341     if (SubSystems & FGAircraft::ssGroundReactions) {
 342       datafile << ", ";
 343       datafile << Aircraft->GetGroundReactionStrings();
 344     }
 345     if (SubSystems & FGAircraft::ssFCS) {
 346       datafile << ", ";
 347       datafile << FCS->GetComponentStrings();
 348     }
 349     datafile << endl;
 350     sFirstPass = false;
 351   }
 352
 353   datafile << State->Getsim_time();
 354   if (SubSystems & FGAircraft::ssSimulation) {
 355   }
 356   if (SubSystems & FGAircraft::ssAerosurfaces) {
 357     datafile << ", ";
 358     datafile << FCS->GetThrottlePos(0) << ", ";
 359     datafile << FCS->GetDaCmd() << ", ";
 360     datafile << FCS->GetDeCmd() << ", ";
 361     datafile << FCS->GetDrCmd() << ", ";
 362     datafile << FCS->GetDaPos() << ", ";
 363     datafile << FCS->GetDePos() << ", ";
 364     datafile << FCS->GetDrPos();
 365   }
 366   if (SubSystems & FGAircraft::ssRates) {
 367     datafile << ", ";
 368     datafile << Rotation->GetPQR();
 369   }
 370   if (SubSystems & FGAircraft::ssVelocities) {
 371     datafile << ", ";
 372     datafile << Translation->Getqbar() << ", ";
 373     datafile << Translation->GetVt() << ", ";
 374     datafile << Translation->GetUVW() << ", ";
 375     datafile << Position->GetVel();
 376   }
 377   if (SubSystems & FGAircraft::ssForces) {
 378     datafile << ", ";
 379     datafile << Aircraft->GetvFs() << ", ";
 380     datafile << Aircraft->GetForces();
 381   }
 382   if (SubSystems & FGAircraft::ssMoments) {
 383     datafile << ", ";
 384     datafile << Aircraft->GetMoments();
 385   }
 386   if (SubSystems & FGAircraft::ssAtmosphere) {
 387     datafile << ", ";
 388     datafile << Atmosphere->GetDensity();
 389   }
 390   if (SubSystems & FGAircraft::ssMassProps) {
 391     datafile << ", ";
 392     datafile << Aircraft->GetIxx() << ", ";
 393     datafile << Aircraft->GetIyy() << ", ";
 394     datafile << Aircraft->GetIzz() << ", ";
 395     datafile << Aircraft->GetIxz() << ", ";
 396     datafile << Aircraft->GetMass() << ", ";
 397     datafile << Aircraft->GetXYZcg();
 398   }
 399   if (SubSystems & FGAircraft::ssPosition) {
 400     datafile << ", ";
 401     datafile << Position->Geth() << ", ";
 402     datafile << Rotation->GetEuler() << ", ";
 403     datafile << Translation->Getalpha() << ", ";
 404     datafile << Position->GetLatitude() << ", ";
 405     datafile << Position->GetLongitude() << ", ";
 406     datafile << Position->GetDistanceAGL() << ", ";
 407     datafile << Position->GetRunwayRadius();
 408   }
 409   if (SubSystems & FGAircraft::ssCoefficients) {
 410     datafile << ", ";
 411     datafile << Aircraft->GetCoefficientValues();
 412   }
 413   if (SubSystems & FGAircraft::ssGroundReactions) {
 414     datafile << ", ";
 415     datafile << Aircraft->GetGroundReactionValues();
 416   }
 417   if (SubSystems & FGAircraft::ssFCS) {
 418     datafile << ", ";
 419     datafile << FCS->GetComponentValues();
 420   }
 421   datafile << endl;
 422   datafile.flush();
 423 }
 424
 425 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 426
 427 void FGOutput::SocketOutput(void)
 428 {
 429   string asciiData;
 430   /*
 431   if (socket == NULL) return;
 432
 433   socket->Clear();
 434   if (sFirstPass) {
 435     socket->Append("<LABELS>");
 436     socket->Append("Time");
 437     socket->Append("Altitude");
 438     socket->Append("Phi");
 439     socket->Append("Tht");
 440     socket->Append("Psi");
 441     socket->Append("Rho");
 442     socket->Append("Vtotal");
 443     socket->Append("U");
 444     socket->Append("V");
 445     socket->Append("W");
 446     socket->Append("Vn");
 447     socket->Append("Ve");
 448     socket->Append("Vd");
 449     socket->Append("Udot");
 450     socket->Append("Vdot");
 451     socket->Append("Wdot");
 452     socket->Append("P");
 453     socket->Append("Q");
 454     socket->Append("R");
 455     socket->Append("PDot");
 456     socket->Append("QDot");
 457     socket->Append("RDot");
 458     socket->Append("Fx");
 459     socket->Append("Fy");
 460     socket->Append("Fz");
 461     socket->Append("Latitude");
 462     socket->Append("Longitude");
 463     socket->Append("QBar");
 464     socket->Append("Alpha");
 465     socket->Append("L");
 466     socket->Append("M");
 467     socket->Append("N");
 468     socket->Append("Throttle");
 469     socket->Append("Aileron");
 470     socket->Append("Elevator");
 471     socket->Append("Rudder");
 472     sFirstPass = false;
 473     socket->Send();
 474   }
 475
 476   socket->Clear();
 477   socket->Append(State->Getsim_time());
 478   socket->Append(Position->Geth());
 479   socket->Append(Rotation->Getphi());
 480   socket->Append(Rotation->Gettht());
 481   socket->Append(Rotation->Getpsi());
 482   socket->Append(Atmosphere->GetDensity());
 483   socket->Append(Translation->GetVt());
 484   socket->Append(Translation->GetU());
 485   socket->Append(Translation->GetV());
 486   socket->Append(Translation->GetW());
 487   socket->Append(Position->GetVn());
 488   socket->Append(Position->GetVe());
 489   socket->Append(Position->GetVd());
 490   socket->Append(Translation->GetUdot());
 491   socket->Append(Translation->GetVdot());
 492   socket->Append(Translation->GetWdot());
 493   socket->Append(Rotation->GetP());
 494   socket->Append(Rotation->GetQ());
 495   socket->Append(Rotation->GetR());
 496   socket->Append(Rotation->GetPdot());
 497   socket->Append(Rotation->GetQdot());
 498   socket->Append(Rotation->GetRdot());
 499   socket->Append(Aircraft->GetFx());
 500   socket->Append(Aircraft->GetFy());
 501   socket->Append(Aircraft->GetFz());
 502   socket->Append(Position->GetLatitude());
 503   socket->Append(Position->GetLongitude());
 504   socket->Append(Translation->Getqbar());
 505   socket->Append(Translation->Getalpha());
 506   socket->Append(Aircraft->GetL());
 507   socket->Append(Aircraft->GetM());
 508   socket->Append(Aircraft->GetN());
 509   socket->Append(FCS->GetThrottle(0));
 510   socket->Append(FCS->GetDa());
 511   socket->Append(FCS->GetDe());
 512   socket->Append(FCS->GetDr());
 513   socket->Send(); */
 514 }
 515
 516 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 517
 518 void FGOutput::SocketStatusOutput(string out_str)
 519 {
 520   string asciiData;
 521
 522   if (socket == NULL) return;
 523
 524   socket->Clear();
 525   asciiData = string("<STATUS>") + out_str;
 526   socket->Append(asciiData.c_str());
 527   socket->Send();
 528 }
 529
 530 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 531
 532 void FGOutput::Debug(void)
 533 {
 534     //TODO: Add your source code here
 535 }
 536