1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4 Date started: 12/21/2001
6 ------------- Copyright (C) 2001 Jon S. Berndt (jsb@hal-pc.org) -------------
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
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
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.
22 Further information about the GNU General Public License can also be found on
23 the world wide web at http://www.gnu.org.
26 --------------------------------------------------------------------------------
29 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
33 #ifndef FGSCRIPT_HEADER_H
34 #define FGSCRIPT_HEADER_H
36 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40 #include "FGJSBBase.h"
42 #include "FGFDMExec.h"
45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
49 #define ID_FGSCRIPT "$Id$"
51 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
55 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
56 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
59 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
63 /** Encapsulates the JSBSim scripting capability.
67 <h4>Scripting support provided via FGScript.</h4>
69 <p>There is simple scripting support provided in the FGScript
70 class. Commands are specified using the <u>Simple Scripting
71 Directives for JSBSim</u> (SSDJ). The script file is in XML
72 format. A test condition (or conditions) can be set up in the
73 script and when the condition evaluates to true, the specified
74 action[s] is/are taken. A test condition can be <em>persistent</em>,
75 meaning that if a test condition evaluates to true, then passes
76 and evaluates to false, the condition is reset and may again be
77 triggered. When the set of tests evaluates to true for a given
78 condition, an item may be set to another value. This value might
79 be a boolean, a value, or a delta value, and the change from the
80 current value to the new value can be either via a step function,
81 a ramp, or an exponential approach. The speed of a ramp or
82 approach is specified via the time constant. Here is the format
83 of the script file:</p>
85 <pre><strong><?xml version="1.0"?>
86 <runscript name="C172-01A">
89 This run is for testing C172 runs
92 <use aircraft="c172">
93 <use initialize="reset00">
95 <run start="0.0" end="4.5" dt="0.05">
97 <parameter name="FG_TIME" comparison="ge" value="0.25">
98 <parameter name="FG_TIME" comparison="le" value="0.50">
99 <set name="FG_AILERON_CMD" type="FG_VALUE" value="0.25"
100 action="FG_STEP" persistent="false" tc ="0.25">
103 <parameter name="FG_TIME" comparison="ge" value="0.5">
104 <parameter name="FG_TIME" comparison="le" value="1.5">
105 <set name="FG_AILERON_CMD" type="FG_DELTA" value="0.5"
106 action="FG_EXP" persistent="false" tc ="0.5">
109 <parameter name="FG_TIME" comparison="ge" value="1.5">
110 <parameter name="FG_TIME" comparison="le" value="2.5">
111 <set name="FG_RUDDER_CMD" type="FG_DELTA" value="0.5"
112 action="FG_RAMP" persistent="false" tc ="0.5">
116 </runscript></strong></pre>
118 <p>The first line must always be present. The second line
119 identifies this file as a script file, and gives a descriptive
120 name to the script file. Comments are next, delineated by the
121 <!-- and --> symbols. The aircraft and initialization files
122 to be used are specified in the "use" lines. Next,
123 comes the "run" section, where the conditions are
124 described in "when" clauses.</p>
128 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
130 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
132 class FGScript : public FGJSBBase
135 /// Default constructor
136 FGScript(FGFDMExec* exec);
138 /// Default destructor
141 /** Loads a script to drive JSBSim (usually in standalone mode).
142 The language is the Simple Script Directives for JSBSim (SSDJ).
143 @param script the filename (including path name, if any) for the script.
144 @return true if successful */
145 bool LoadScript(string script);
147 /** This function is called each pass through the executive Run() method IF
148 scripting is enabled.
149 @return false if script should exit (i.e. if time limits are violated */
150 bool RunScript(void);
166 vector <eParam> TestParam;
167 vector <eParam> SetParam;
168 vector <double> TestValue;
169 vector <double> SetValue;
170 vector <string> Comparison;
172 vector <bool> Persistent;
173 vector <eAction> Action;
175 vector <bool> Triggered;
176 vector <double> newValue;
177 vector <double> OriginalValue;
178 vector <double> StartTime;
179 vector <double> EndTime;
190 vector <struct condition> Conditions;
194 void Debug(int from);
197 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%