src/FDM/JSBSim/models/FGInput.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGInput.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 Lesser 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 Lesser General Public License for more
  19  details.
  20
  21  You should have received a copy of the GNU Lesser 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 Lesser 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 "FGInput.h"
  42 #include "FGState.h"
  43 #include "FGFDMExec.h"
  44
  45 #include <fstream>
  46 #include <iomanip>
  47
  48 namespace JSBSim {
  49
  50 static const char *IdSrc = "$Id$";
  51 static const char *IdHdr = ID_INPUT;
  52
  53 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  54 CLASS IMPLEMENTATION
  55 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  56
  57 FGInput::FGInput(FGFDMExec* fdmex) : FGModel(fdmex)
  58 {
  59   Name = "FGInput";
  60   sFirstPass = dFirstPass = true;
  61   socket = 0;
  62   port = 0;
  63   enabled = true;
  64
  65   Debug(0);
  66 }
  67
  68 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  69
  70 FGInput::~FGInput()
  71 {
  72   delete socket;
  73   Debug(1);
  74 }
  75
  76 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  77
  78 bool FGInput::InitModel(void)
  79 {
  80   if (!FGModel::InitModel()) return false;
  81
  82   return true;
  83 }
  84
  85 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  86 //
  87 // This function handles accepting input commands from the socket interface.
  88 //
  89
  90 bool FGInput::Run(void)
  91 {
  92   string line, token, info_string;
  93   int start=0, string_start=0, string_end=0;
  94   int token_start=0, token_end=0;
  95   char buf[100];
  96   double value=0;
  97   FGPropertyManager* node=0;
  98
  99   if (FGModel::Run()) return true; // fast exit if nothing to do
 100   if (port == 0) return false;      // Do nothing here if port not defined
 101                                     // return false if no error
 102   // This model DOES execute if "Exec->Holding"
 103
 104   data = socket->Receive(); // get socket transmission if present
 105
 106   if (data.size() > 0) {
 107     // parse lines
 108     while (1) {
 109       string_start = data.find_first_not_of("\r\n", start);
 110       if (string_start == string::npos) break;
 111       string_end = data.find_first_of("\r\n", string_start);
 112       if (string_end == string::npos) break;
 113       line = data.substr(string_start, string_end-string_start);
 114       if (line.size() == 0) break;
 115
 116       // now parse individual line
 117       vector <string> tokens = split(line,' ');
 118
 119       string command="", argument="", str_value="";
 120       if (tokens.size() > 0) {
 121         command = to_lower(tokens[0]);
 122         if (tokens.size() > 1) {
 123           argument = trim(tokens[1]);
 124           if (tokens.size() > 2) {
 125             str_value = trim(tokens[2]);
 126           }
 127         }
 128       }
 129
 130       if (command == "set") {                   // SET PROPERTY
 131
 132         node = PropertyManager->GetNode(argument);
 133         if (node == 0)
 134           socket->Reply("Unknown property\n");
 135         else {
 136           value = atof(str_value.c_str());
 137           node->setDoubleValue(value);
 138         }
 139         socket->Reply("");
 140
 141       } else if (command == "get") {             // GET PROPERTY
 142
 143         if (argument.size() == 0) {
 144           socket->Reply("No property argument supplied.\n");
 145           break;
 146         }
 147         try {
 148           node = PropertyManager->GetNode(argument);
 149         } catch(...) {
 150           socket->Reply("Badly formed property query\n");
 151           break;
 152         }
 153         if (node == 0) {
 154           if (FDMExec->Holding()) { // if holding can query property list
 155             string query = FDMExec->QueryPropertyCatalog(argument);
 156             socket->Reply(query);
 157           } else {
 158             socket->Reply("Must be in HOLD to search properties\n");
 159           }
 160         } else if (node > 0) {
 161           sprintf(buf, "%s = %12.6f\n", argument.c_str(), node->getDoubleValue());
 162           socket->Reply(buf);
 163         }
 164
 165       } else if (command == "hold") {                  // PAUSE
 166
 167         FDMExec->Hold();
 168         socket->Reply("");
 169
 170       } else if (command == "resume") {             // RESUME
 171
 172         FDMExec->Resume();
 173         socket->Reply("");
 174
 175       } else if (command == "quit") {                   // QUIT
 176
 177         // close the socket connection
 178         socket->Reply("");
 179         socket->Close();
 180
 181       } else if (command == "info") {                   // INFO
 182
 183         // get info about the sim run and/or aircraft, etc.
 184         sprintf(buf, "%8.3f\0", State->Getsim_time());
 185         info_string  = "JSBSim version: " + JSBSim_version + "\n";
 186         info_string += "Config File version: " + needed_cfg_version + "\n";
 187         info_string += "Aircraft simulated: " + Aircraft->GetAircraftName() + "\n";
 188         info_string += "Simulation time: " + string(buf) + "\n";
 189         socket->Reply(info_string);
 190
 191       } else if (command == "help") {                   // HELP
 192
 193         socket->Reply(
 194         " JSBSim Server commands:\n\n"
 195         "   get {property name}\n"
 196         "   set {property name} {value}\n"
 197         "   hold\n"
 198         "   resume\n"
 199         "   help\n"
 200         "   quit\n"
 201         "   info\n\n");
 202
 203       } else {
 204         socket->Reply(string("Unknown command: ") +  token + string("\n"));
 205       }
 206
 207       start = string_end;
 208     }
 209   }
 210
 211   return false;
 212 }
 213
 214 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 215
 216 bool FGInput::Load(Element* element)
 217 {
 218   string type="", parameter="";
 219   string name="", fname="";
 220   string property;
 221
 222   // if the input has already been set up, print a warning message and return
 223   if (port > 0) {
 224     cerr << "An input port has already been assigned for this run" << endl;
 225     return false;
 226   }
 227
 228   port = int(element->GetAttributeValueAsNumber("port"));
 229   if (port == 0) {
 230     cerr << endl << "No port assigned in input element" << endl;
 231   } else {
 232     socket = new FGfdmSocket(port);
 233   }
 234
 235   Debug(2);
 236
 237   return true;
 238 }
 239
 240 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 241 //    The bitmasked value choices are as follows:
 242 //    unset: In this case (the default) JSBSim would only print
 243 //       out the normally expected messages, essentially echoing
 244 //       the config files as they are read. If the environment
 245 //       variable is not set, debug_lvl is set to 1 internally
 246 //    0: This requests JSBSim not to output any messages
 247 //       whatsoever.
 248 //    1: This value explicity requests the normal JSBSim
 249 //       startup messages
 250 //    2: This value asks for a message to be printed out when
 251 //       a class is instantiated
 252 //    4: When this value is set, a message is displayed when a
 253 //       FGModel object executes its Run() method
 254 //    8: When this value is set, various runtime state variables
 255 //       are printed out periodically
 256 //    16: When set various parameters are sanity checked and
 257 //       a message is printed out when they go out of bounds
 258
 259 void FGInput::Debug(int from)
 260 {
 261   string scratch="";
 262
 263   if (debug_lvl <= 0) return;
 264
 265   if (debug_lvl & 1) { // Standard console startup message output
 266     if (from == 0) { // Constructor
 267     }
 268     if (from == 2) {
 269     }
 270   }
 271   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 272     if (from == 0) cout << "Instantiated: FGInput" << endl;
 273     if (from == 1) cout << "Destroyed:    FGInput" << endl;
 274   }
 275   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 276   }
 277   if (debug_lvl & 8 ) { // Runtime state variables
 278   }
 279   if (debug_lvl & 16) { // Sanity checking
 280   }
 281   if (debug_lvl & 64) {
 282     if (from == 0) { // Constructor
 283       cout << IdSrc << endl;
 284       cout << IdHdr << endl;
 285     }
 286   }
 287 }
 288 }