src/FDM/JSBSim/FGScript.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2  Header:       FGScript.h
   3  Author:       Jon Berndt
   4  Date started: 12/21/2001
   5
   6  ------------- Copyright (C) 2001  Jon S. Berndt (jsb@hal-pc.org) -------------
   7
   8  This program is free software; you can redistribute it and/or modify it under
   9  the terms of the GNU General Public License as published by the Free Software
  10  Foundation; either version 2 of the License, or (at your option) any later
  11  version.
  12
  13  This program is distributed in the hope that it will be useful, but WITHOUT
  14  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  details.
  17
  18  You should have received a copy of the GNU General Public License along with
  19  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  20  Place - Suite 330, Boston, MA  02111-1307, USA.
  21
  22  Further information about the GNU General Public License can also be found on
  23  the world wide web at http://www.gnu.org.
  24
  25 HISTORY
  26 --------------------------------------------------------------------------------
  27 12/21/01   JSB   Created
  28
  29 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  30 SENTRY
  31 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  32
  33 #ifndef FGSCRIPT_HEADER_H
  34 #define FGSCRIPT_HEADER_H
  35
  36 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 INCLUDES
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  39
  40 #include "FGJSBBase.h"
  41 #include "FGState.h"
  42 #include "FGFDMExec.h"
  43 #include <vector>
  44
  45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  46 DEFINITIONS
  47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  48
  49 #define ID_FGSCRIPT "$Id$"
  50
  51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52 FORWARD DECLARATIONS
  53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  54
  55 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  56 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  58
  59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  60 CLASS DOCUMENTATION
  61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  62
  63 /** Encapsulates the JSBSim scripting capability.
  64     @author Jon S. Berndt
  65     @version $Id$
  66     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGScript.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
  67          Header File </a>
  68     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGScript.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
  69          Source File </a>
  70
  71     <h4>Scripting support provided via FGScript.</h4>
  72
  73     <p>There is simple scripting support provided in the FGScript
  74     class. Commands are specified using the <u>Simple Scripting
  75     Directives for JSBSim</u> (SSDJ). The script file is in XML
  76     format. A test condition (or conditions) can be set up in the
  77     script and when the condition evaluates to true, the specified
  78     action[s] is/are taken. A test condition can be <em>persistent</em>,
  79     meaning that if a test condition evaluates to true, then passes
  80     and evaluates to false, the condition is reset and may again be
  81     triggered. When the set of tests evaluates to true for a given
  82     condition, an item may be set to another value. This value might
  83     be a boolean, a value, or a delta value, and the change from the
  84     current value to the new value can be either via a step function,
  85     a ramp, or an exponential approach. The speed of a ramp or
  86     approach is specified via the time constant. Here is the format
  87     of the script file:</p>
  88
  89     <pre><strong>&lt;?xml version=&quot;1.0&quot;?&gt;
  90     &lt;runscript name=&quot;C172-01A&quot;&gt;
  91
  92     &lt;!--
  93     This run is for testing C172 runs
  94     --&gt;
  95
  96     &lt;use aircraft=&quot;c172&quot;&gt;
  97     &lt;use initialize=&quot;reset00&quot;&gt;
  98
  99     &lt;run start=&quot;0.0&quot; end=&quot;4.5&quot; dt=&quot;0.05&quot;&gt;
 100       &lt;when&gt;
 101         &lt;parameter name=&quot;FG_TIME&quot; comparison=&quot;ge&quot; value=&quot;0.25&quot;&gt;
 102         &lt;parameter name=&quot;FG_TIME&quot; comparison=&quot;le&quot; value=&quot;0.50&quot;&gt;
 103         &lt;set name=&quot;FG_AILERON_CMD&quot; type=&quot;FG_VALUE&quot; value=&quot;0.25&quot;
 104         action=&quot;FG_STEP&quot; persistent=&quot;false&quot; tc =&quot;0.25&quot;&gt;
 105       &lt;/when&gt;
 106       &lt;when&gt;
 107         &lt;parameter name=&quot;FG_TIME&quot; comparison=&quot;ge&quot; value=&quot;0.5&quot;&gt;
 108         &lt;parameter name=&quot;FG_TIME&quot; comparison=&quot;le&quot; value=&quot;1.5&quot;&gt;
 109         &lt;set name=&quot;FG_AILERON_CMD&quot; type=&quot;FG_DELTA&quot; value=&quot;0.5&quot;
 110         action=&quot;FG_EXP&quot; persistent=&quot;false&quot; tc =&quot;0.5&quot;&gt;
 111       &lt;/when&gt;
 112       &lt;when&gt;
 113         &lt;parameter name=&quot;FG_TIME&quot; comparison=&quot;ge&quot; value=&quot;1.5&quot;&gt;
 114         &lt;parameter name=&quot;FG_TIME&quot; comparison=&quot;le&quot; value=&quot;2.5&quot;&gt;
 115         &lt;set name=&quot;FG_RUDDER_CMD&quot; type=&quot;FG_DELTA&quot; value=&quot;0.5&quot;
 116         action=&quot;FG_RAMP&quot; persistent=&quot;false&quot; tc =&quot;0.5&quot;&gt;
 117       &lt;/when&gt;
 118     &lt;/run&gt;
 119
 120     &lt;/runscript&gt;</strong></pre>
 121
 122     <p>The first line must always be present. The second line
 123     identifies this file as a script file, and gives a descriptive
 124     name to the script file. Comments are next, delineated by the
 125     &lt;!-- and --&gt; symbols. The aircraft and initialization files
 126     to be used are specified in the &quot;use&quot; lines. Next,
 127     comes the &quot;run&quot; section, where the conditions are
 128     described in &quot;when&quot; clauses.</p>
 129
 130 */
 131
 132 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 133 CLASS DECLARATION
 134 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 135
 136 class FGScript : public FGJSBBase
 137 {
 138 public:
 139   /// Default constructor
 140   FGScript(FGFDMExec* exec);
 141
 142   /// Default destructor
 143   ~FGScript();
 144
 145   /** Loads a script to drive JSBSim (usually in standalone mode).
 146       The language is the Simple Script Directives for JSBSim (SSDJ).
 147       @param script the filename (including path name, if any) for the script.
 148       @return true if successful */
 149   bool LoadScript( string script );
 150
 151   /** This function is called each pass through the executive Run() method IF
 152       scripting is enabled.
 153       @return false if script should exit (i.e. if time limits are violated */
 154   bool RunScript(void);
 155
 156 private:
 157   enum eAction {
 158     FG_RAMP  = 1,
 159     FG_STEP  = 2,
 160     FG_EXP   = 3
 161   };
 162
 163   enum eType {
 164     FG_VALUE = 1,
 165     FG_DELTA = 2,
 166     FG_BOOL  = 3
 167   };
 168
 169   struct condition {
 170     vector <FGPropertyManager*>  TestParam;
 171     vector <FGPropertyManager*>  SetParam;
 172     vector <double>  TestValue;
 173     vector <double>  SetValue;
 174     vector <string>  Comparison;
 175     vector <double>  TC;
 176     vector <bool>    Persistent;
 177     vector <eAction> Action;
 178     vector <eType>   Type;
 179     vector <bool>    Triggered;
 180     vector <double>  newValue;
 181     vector <double>  OriginalValue;
 182     vector <double>  StartTime;
 183     vector <double>  EndTime;
 184
 185     condition() {
 186     }
 187   };
 188
 189   bool Scripted;
 190
 191   string  ScriptName;
 192   double  StartTime;
 193   double  EndTime;
 194   vector <struct condition> Conditions;
 195
 196   FGFDMExec* FDMExec;
 197   FGState* State;
 198   FGPropertyManager* PropertyManager;
 199   void Debug(int from);
 200 };
 201
 202 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 203 #endif
 204