src/FDM/JSBSim/input_output/FGScript.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGScript.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 12/21/01
   6  Purpose:      Loads and runs JSBSim scripts.
   7
   8  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU Lesser General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU Lesser General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU Lesser General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29
  30 This class wraps up the simulation scripting routines.
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 12/21/01   JSB   Created
  35
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 COMMENTS, REFERENCES,  and NOTES
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  39
  40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  41 INCLUDES
  42 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  43
  44 #include "FGScript.h"
  45 #include <input_output/FGXMLParse.h>
  46 #include <initialization/FGTrim.h>
  47
  48 #include <iostream>
  49
  50 namespace JSBSim {
  51
  52 static const char *IdSrc = "$Id$";
  53 static const char *IdHdr = ID_FGSCRIPT;
  54
  55 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  56 GLOBAL DECLARATIONS
  57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  58
  59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  60 CLASS IMPLEMENTATION
  61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  62
  63 // Constructor
  64
  65 FGScript::FGScript(FGFDMExec* fgex) : FDMExec(fgex)
  66 {
  67   State = FDMExec->GetState();
  68   PropertyManager=FDMExec->GetPropertyManager();
  69   Debug(0);
  70 }
  71
  72 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  73
  74 FGScript::~FGScript()
  75 {
  76   unsigned int i;
  77
  78   for (i=0; i<local_properties.size(); i++) delete local_properties[i];
  79   local_properties.clear();
  80
  81   for (i=0; i<Events.size(); i++) delete Events[i].Condition;
  82   Events.clear();
  83
  84   Debug(1);
  85 }
  86
  87 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  88
  89 bool FGScript::LoadScript( string script )
  90 {
  91   string aircraft="", initialize="", comparison = "", prop_name="";
  92   string notifyPropertyName="";
  93   Element *element=0, *run_element=0, *event_element=0;
  94   Element *condition_element=0, *set_element=0, *delay_element=0;
  95   Element *notify_element = 0L, *notify_property_element = 0L;
  96   Element *property_element = 0L;
  97   Element *output_element = 0L;
  98   Element *input_element = 0L;
  99   bool result = false;
 100   double dt = 0.0, value = 0.0;
 101   struct event *newEvent;
 102   FGCondition *newCondition;
 103
 104   document = LoadXMLDocument(script);
 105
 106   if (!document) {
 107     cerr << "File: " << script << " could not be loaded." << endl;
 108     return false;
 109   }
 110
 111   // Set up input and output files if specified
 112
 113   output_element = document->FindElement("output");
 114   input_element = document->FindElement("input");
 115
 116   if (document->GetName() != string("runscript")) {
 117     cerr << "File: " << script << " is not a script file" << endl;
 118     return false;
 119   }
 120
 121   ScriptName = document->GetAttributeValue("name");
 122
 123  // First, find "run" element and set delta T
 124
 125   run_element = document->FindElement("run");
 126
 127   if (!run_element) {
 128     cerr << "No \"run\" element found in script." << endl;
 129     return false;
 130   }
 131
 132   // Set sim timing
 133
 134   StartTime = run_element->GetAttributeValueAsNumber("start");
 135   State->Setsim_time(StartTime);
 136   EndTime   = run_element->GetAttributeValueAsNumber("end");
 137   dt        = run_element->GetAttributeValueAsNumber("dt");
 138   State->Setdt(dt);
 139
 140   // read aircraft and initialization files
 141
 142   element = document->FindElement("use");
 143   if (element) {
 144     aircraft = element->GetAttributeValue("aircraft");
 145     if (!aircraft.empty()) {
 146       result = FDMExec->LoadModel(aircraft);
 147       if (!result) return false;
 148     } else {
 149       cerr << "Aircraft must be specified in use element." << endl;
 150       return false;
 151     }
 152
 153     initialize = element->GetAttributeValue("initialize");
 154     if (initialize.empty()) {
 155       cerr << "Initialization file must be specified in use element." << endl;
 156       return false;
 157     }
 158
 159   } else {
 160     cerr << "No \"use\" directives in the script file." << endl;
 161     return false;
 162   }
 163
 164   // Now, read input spec if given.
 165   if (input_element > 0) {
 166     FDMExec->GetInput()->Load(input_element);
 167   }
 168
 169   // Now, read output spec if given.
 170   if (output_element > 0) {
 171     string output_file = output_element->GetAttributeValue("file");
 172     if (output_file.empty()) {
 173       cerr << "No logging directives file was specified." << endl;
 174     } else {
 175       FDMExec->SetOutputDirectives(output_file);
 176     }
 177   }
 178
 179   // Read local property/value declarations
 180   property_element = run_element->FindElement("property");
 181   while (property_element) {
 182
 183     double value=0.0;
 184     if ( ! property_element->GetAttributeValue("value").empty())
 185       value = property_element->GetAttributeValueAsNumber("value");
 186
 187     LocalProps *localProp = new LocalProps(value);
 188     localProp->title = property_element->GetDataLine();
 189     local_properties.push_back(localProp);
 190
 191     PropertyManager->Tie(localProp->title, (local_properties.back())->value);
 192     property_element = run_element->FindNextElement("property");
 193   }
 194
 195   // Read "events" from script
 196
 197   event_element = run_element->FindElement("event");
 198   while (event_element) { // event processing
 199
 200     // Create the event structure
 201     newEvent = new struct event();
 202
 203     // Retrieve the event name if given
 204     newEvent->Name = event_element->GetAttributeValue("name");
 205
 206     // Is this event persistent? That is, does it execute every time the
 207     // condition triggers to true, or does it execute as a one-shot event, only?
 208     if (event_element->GetAttributeValue("persistent") == string("true")) {
 209       newEvent->Persistent = true;
 210     }
 211
 212     // Does this event execute continuously when triggered to true?
 213     if (event_element->GetAttributeValue("continuous") == string("true")) {
 214       newEvent->Continuous = true;
 215     }
 216
 217     // Process the conditions
 218     condition_element = event_element->FindElement("condition");
 219     if (condition_element != 0) {
 220       newCondition = new FGCondition(condition_element, PropertyManager);
 221       newEvent->Condition = newCondition;
 222     } else {
 223       cerr << "No condition specified in script event " << newEvent->Name << endl;
 224       return false;
 225     }
 226
 227     // Is there a delay between the time this event is triggered, and when the event
 228     // actions are executed?
 229
 230     delay_element = event_element->FindElement("delay");
 231     if (delay_element) newEvent->Delay = event_element->FindElementValueAsNumber("delay");
 232     else newEvent->Delay = 0.0;
 233
 234     // Notify about when this event is triggered?
 235     if ((notify_element = event_element->FindElement("notify")) != 0) {
 236       newEvent->Notify = true;
 237       notify_property_element = notify_element->FindElement("property");
 238       while (notify_property_element) {
 239         notifyPropertyName = notify_property_element->GetDataLine();
 240         if (PropertyManager->GetNode(notifyPropertyName)) {
 241           newEvent->NotifyProperties.push_back( PropertyManager->GetNode(notifyPropertyName) );
 242         } else {
 243           cout << endl << fgred << "  Could not find the property named "
 244                << notifyPropertyName << " in script" << endl << "  \""
 245                << ScriptName << "\". This unknown property will not be "
 246                << "echoed for notification." << reset << endl;
 247         }
 248         notify_property_element = notify_element->FindNextElement("property");
 249       }
 250     }
 251
 252     // Read set definitions (these define the actions to be taken when the event is triggered).
 253     set_element = event_element->FindElement("set");
 254     while (set_element) {
 255       prop_name = set_element->GetAttributeValue("name");
 256       newEvent->SetParam.push_back( PropertyManager->GetNode(prop_name) );
 257       //Todo - should probably do some safety checking here to make sure one or the other
 258       //of value or function is specified.
 259       if (!set_element->GetAttributeValue("value").empty()) {
 260         value = set_element->GetAttributeValueAsNumber("value");
 261         newEvent->Functions.push_back((FGFunction*)0L);
 262       } else if (set_element->FindElement("function")) {
 263         value = 0.0;
 264         newEvent->Functions.push_back(new FGFunction(PropertyManager, set_element->FindElement("function")));
 265       }
 266       newEvent->SetValue.push_back(value);
 267       newEvent->OriginalValue.push_back(0.0);
 268       newEvent->newValue.push_back(0.0);
 269       newEvent->ValueSpan.push_back(0.0);
 270       string tempCompare = set_element->GetAttributeValue("type");
 271       if      (tempCompare == "FG_DELTA") newEvent->Type.push_back(FG_DELTA);
 272       else if (tempCompare == "FG_BOOL")  newEvent->Type.push_back(FG_BOOL);
 273       else if (tempCompare == "FG_VALUE") newEvent->Type.push_back(FG_VALUE);
 274       else                                newEvent->Type.push_back(FG_VALUE); // DEFAULT
 275       tempCompare = set_element->GetAttributeValue("action");
 276       if      (tempCompare == "FG_RAMP") newEvent->Action.push_back(FG_RAMP);
 277       else if (tempCompare == "FG_STEP") newEvent->Action.push_back(FG_STEP);
 278       else if (tempCompare == "FG_EXP")  newEvent->Action.push_back(FG_EXP);
 279       else                               newEvent->Action.push_back(FG_STEP); // DEFAULT
 280
 281       if (!set_element->GetAttributeValue("tc").empty())
 282         newEvent->TC.push_back(set_element->GetAttributeValueAsNumber("tc"));
 283       else
 284         newEvent->TC.push_back(1.0); // DEFAULT
 285
 286       newEvent->Transiting.push_back(false);
 287
 288       set_element = event_element->FindNextElement("set");
 289     }
 290     Events.push_back(*newEvent);
 291     delete newEvent;
 292
 293     event_element = run_element->FindNextElement("event");
 294   }
 295
 296   Debug(4);
 297
 298   FGInitialCondition *IC=FDMExec->GetIC();
 299   if ( ! IC->Load( initialize )) {
 300     cerr << "Initialization unsuccessful" << endl;
 301     exit(-1);
 302   }
 303
 304   return true;
 305 }
 306
 307 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 308
 309 bool FGScript::RunScript(void)
 310 {
 311   unsigned i, j;
 312   unsigned event_ctr = 0;
 313
 314   double currentTime = State->Getsim_time();
 315   double newSetValue = 0;
 316
 317   if (currentTime > EndTime) return false; //Script done!
 318
 319   // Iterate over all events.
 320   for (unsigned int ev_ctr=0; ev_ctr < Events.size(); ev_ctr++) {
 321     // Determine whether the set of conditional tests for this condition equate
 322     // to true and should cause the event to execute. If the conditions evaluate
 323     // to true, then the event is triggered. If the event is not persistent,
 324     // then this trigger will remain set true. If the event is persistent,
 325     // the trigger will reset to false when the condition evaluates to false.
 326     if (Events[ev_ctr].Condition->Evaluate()) {
 327       if (!Events[ev_ctr].Triggered) {
 328
 329         // The conditions are true, do the setting of the desired Event parameters
 330         for (i=0; i<Events[ev_ctr].SetValue.size(); i++) {
 331           Events[ev_ctr].OriginalValue[i] = Events[ev_ctr].SetParam[i]->getDoubleValue();
 332           if (Events[ev_ctr].Functions[i] != 0) { // Parameter should be set to a function value
 333             Events[ev_ctr].SetValue[i] = Events[ev_ctr].Functions[i]->GetValue();
 334           }
 335           switch (Events[ev_ctr].Type[i]) {
 336           case FG_VALUE:
 337           case FG_BOOL:
 338             Events[ev_ctr].newValue[i] = Events[ev_ctr].SetValue[i];
 339             break;
 340           case FG_DELTA:
 341             Events[ev_ctr].newValue[i] = Events[ev_ctr].OriginalValue[i] + Events[ev_ctr].SetValue[i];
 342             break;
 343           default:
 344             cerr << "Invalid Type specified" << endl;
 345             break;
 346           }
 347           Events[ev_ctr].StartTime = currentTime + Events[ev_ctr].Delay;
 348           Events[ev_ctr].ValueSpan[i] = Events[ev_ctr].newValue[i] - Events[ev_ctr].OriginalValue[i];
 349           Events[ev_ctr].Transiting[i] = true;
 350         }
 351       }
 352       Events[ev_ctr].Triggered = true;
 353
 354     } else if (Events[ev_ctr].Persistent) { // If the event is persistent, reset the trigger.
 355
 356       Events[ev_ctr].Triggered = false; // Reset the trigger for persistent events
 357       Events[ev_ctr].Notified = false;  // Also reset the notification flag
 358     }
 359
 360     if ((currentTime >= Events[ev_ctr].StartTime) && Events[ev_ctr].Triggered) {
 361
 362       for (i=0; i<Events[ev_ctr].SetValue.size(); i++) {
 363         if (Events[ev_ctr].Transiting[i]) {
 364           Events[ev_ctr].TimeSpan = currentTime - Events[ev_ctr].StartTime;
 365           switch (Events[ev_ctr].Action[i]) {
 366           case FG_RAMP:
 367             if (Events[ev_ctr].TimeSpan <= Events[ev_ctr].TC[i]) {
 368               newSetValue = Events[ev_ctr].TimeSpan/Events[ev_ctr].TC[i] * Events[ev_ctr].ValueSpan[i] + Events[ev_ctr].OriginalValue[i];
 369             } else {
 370               newSetValue = Events[ev_ctr].newValue[i];
 371               if (Events[ev_ctr].Continuous != true) Events[ev_ctr].Transiting[i] = false;
 372             }
 373             break;
 374           case FG_STEP:
 375             newSetValue = Events[ev_ctr].newValue[i];
 376
 377             // If this is not a continuous event, reset the transiting flag.
 378             // Otherwise, it is known that the event is a continuous event.
 379             // Furthermore, if the event is to be determined by a function,
 380             // then the function will be continuously calculated.
 381             if (Events[ev_ctr].Continuous != true)
 382               Events[ev_ctr].Transiting[i] = false;
 383             else if (Events[ev_ctr].Functions[i] != 0)
 384               newSetValue = Events[ev_ctr].Functions[i]->GetValue();
 385
 386             break;
 387           case FG_EXP:
 388             newSetValue = (1 - exp( -Events[ev_ctr].TimeSpan/Events[ev_ctr].TC[i] )) * Events[ev_ctr].ValueSpan[i] + Events[ev_ctr].OriginalValue[i];
 389             break;
 390           default:
 391             cerr << "Invalid Action specified" << endl;
 392             break;
 393           }
 394           Events[ev_ctr].SetParam[i]->setDoubleValue(newSetValue);
 395         }
 396       }
 397
 398       // Print notification values after setting them
 399       if (Events[ev_ctr].Notify && !Events[ev_ctr].Notified) {
 400         cout << endl << "  Event " << event_ctr << " (" << Events[ev_ctr].Name << ")"
 401              << " executed at time: " << currentTime << endl;
 402         for (j=0; j<Events[ev_ctr].NotifyProperties.size();j++) {
 403           cout << "    " << Events[ev_ctr].NotifyProperties[j]->GetName()
 404                << " = " << Events[ev_ctr].NotifyProperties[j]->getDoubleValue() << endl;
 405         }
 406         cout << endl;
 407         Events[ev_ctr].Notified = true;
 408       }
 409
 410     }
 411
 412     event_ctr++;
 413   }
 414   return true;
 415 }
 416
 417 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 418 //    The bitmasked value choices are as follows:
 419 //    unset: In this case (the default) JSBSim would only print
 420 //       out the normally expected messages, essentially echoing
 421 //       the config files as they are read. If the environment
 422 //       variable is not set, debug_lvl is set to 1 internally
 423 //    0: This requests JSBSim not to output any messages
 424 //       whatsoever.
 425 //    1: This value explicity requests the normal JSBSim
 426 //       startup messages
 427 //    2: This value asks for a message to be printed out when
 428 //       a class is instantiated
 429 //    4: When this value is set, a message is displayed when a
 430 //       FGModel object executes its Run() method
 431 //    8: When this value is set, various runtime state variables
 432 //       are printed out periodically
 433 //    16: When set various parameters are sanity checked and
 434 //       a message is printed out when they go out of bounds
 435
 436 void FGScript::Debug(int from)
 437 {
 438   if (debug_lvl <= 0) return;
 439
 440   if (debug_lvl & 1) { // Standard console startup message output
 441     if (from == 0) { // Constructor
 442     } else if (from == 3) {
 443     } else if (from == 4)  { // print out script data
 444       cout << endl;
 445       cout << "Script: \"" << ScriptName << "\"" << endl;
 446       cout << "  begins at " << StartTime << " seconds and runs to " << EndTime
 447            << " seconds with dt = " << State->Getdt() << endl;
 448       cout << endl;
 449
 450       for (unsigned i=0; i<Events.size(); i++) {
 451         cout << "Event " << i;
 452         if (!Events[i].Name.empty()) cout << " (" << Events[i].Name << ")";
 453         cout << ":" << endl;
 454
 455         if (Events[i].Persistent)
 456           cout << "  " << "Always executes";
 457         else
 458           cout << "  " << "Executes once";
 459
 460         Events[i].Condition->PrintCondition();
 461
 462         cout << endl << "  Actions taken:" << endl << "    {";
 463         for (unsigned j=0; j<Events[i].SetValue.size(); j++) {
 464           if (Events[i].SetValue[j] == 0.0 && Events[i].Functions[j] != 0L) {
 465             if (Events[i].SetParam[j] == 0) {
 466               cerr << fgred << highint << endl
 467                    << "  An attempt has been made to access a non-existent property" << endl
 468                    << "  in this event. Please check the property names used, spelling, etc."
 469                    << reset << endl;
 470               exit(-1);
 471             }
 472             cout << endl << "      set " << Events[i].SetParam[j]->GetName()
 473                  << " to function value";
 474           } else {
 475             if (Events[i].SetParam[j] == 0) {
 476               cerr << fgred << highint << endl
 477                    << "  An attempt has been made to access a non-existent property" << endl
 478                    << "  in this event. Please check the property names used, spelling, etc."
 479                    << reset << endl;
 480               exit(-1);
 481             }
 482             cout << endl << "      set " << Events[i].SetParam[j]->GetName()
 483                  << " to " << Events[i].SetValue[j];
 484           }
 485
 486           switch (Events[i].Type[j]) {
 487           case FG_VALUE:
 488           case FG_BOOL:
 489             cout << " (constant";
 490             break;
 491           case FG_DELTA:
 492             cout << " (delta";
 493             break;
 494           default:
 495             cout << " (unspecified type";
 496           }
 497
 498           switch (Events[i].Action[j]) {
 499           case FG_RAMP:
 500             cout << " via ramp";
 501             break;
 502           case FG_STEP:
 503             cout << " via step)";
 504             break;
 505           case FG_EXP:
 506             cout << " via exponential approach";
 507             break;
 508           default:
 509             cout << " via unspecified action)";
 510           }
 511
 512           if (Events[i].Action[j] == FG_RAMP || Events[i].Action[j] == FG_EXP)
 513             cout << " with time constant " << Events[i].TC[j] << ")";
 514         }
 515         cout << endl << "    }" << endl << endl;
 516
 517       }
 518     }
 519   }
 520   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 521     if (from == 0) cout << "Instantiated: FGScript" << endl;
 522     if (from == 1) cout << "Destroyed:    FGScript" << endl;
 523   }
 524   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 525   }
 526   if (debug_lvl & 8 ) { // Runtime state variables
 527   }
 528   if (debug_lvl & 16) { // Sanity checking
 529   }
 530   if (debug_lvl & 64) {
 531     if (from == 0) { // Constructor
 532       cout << IdSrc << endl;
 533       cout << IdHdr << endl;
 534     }
 535   }
 536 }
 537 }