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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
57 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
59 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
61 /** Encapsulates the JSBSim scripting capability.
62 <h4>Scripting support provided via FGScript.</h4>
64 <p>There is simple scripting support provided in the FGScript
65 class. Commands are specified using the <em>Simple Scripting
66 Directives for JSBSim</em> (SSDJ). The script file is in XML
67 format. A test condition (or conditions) can be set up in the
68 script and when the condition evaluates to true, the specified
69 action[s] is/are taken. A test condition can be <em>persistent</em>,
70 meaning that if a test condition evaluates to true, then passes
71 and evaluates to false, the condition is reset and may again be
72 triggered. When the set of tests evaluates to true for a given
73 condition, an item may be set to another value. This value might
74 be a boolean, a value, or a delta value, and the change from the
75 current value to the new value can be either via a step function,
76 a ramp, or an exponential approach. The speed of a ramp or
77 approach is specified via the time constant. Here is the format
78 of the script file:</p>
80 <pre><strong><?xml version="1.0"?>
81 <runscript name="C172-01A">
84 This run is for testing C172 runs
87 <use aircraft="c172">
88 <use initialize="reset00">
90 <run start="0.0" end="4.5" dt="0.05">
92 <parameter name="FG_TIME" comparison="ge" value="0.25">
93 <parameter name="FG_TIME" comparison="le" value="0.50">
94 <set name="FG_AILERON_CMD" type="FG_VALUE" value="0.25"
95 action="FG_STEP" persistent="false" tc ="0.25">
98 <parameter name="FG_TIME" comparison="ge" value="0.5">
99 <parameter name="FG_TIME" comparison="le" value="1.5">
100 <set name="FG_AILERON_CMD" type="FG_DELTA" value="0.5"
101 action="FG_EXP" persistent="false" tc ="0.5">
104 <parameter name="FG_TIME" comparison="ge" value="1.5">
105 <parameter name="FG_TIME" comparison="le" value="2.5">
106 <set name="FG_RUDDER_CMD" type="FG_DELTA" value="0.5"
107 action="FG_RAMP" persistent="false" tc ="0.5">
111 </runscript></strong></pre>
113 <p>The first line must always be present. The second line
114 identifies this file as a script file, and gives a descriptive
115 name to the script file. Comments are next, delineated by the
116 <!-- and --> symbols. The aircraft and initialization files
117 to be used are specified in the "use" lines. Next,
118 comes the "run" section, where the conditions are
119 described in "when" clauses.</p>
120 @author Jon S. Berndt
125 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
127 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
129 class FGScript : public FGJSBBase
132 /// Default constructor
133 FGScript(FGFDMExec* exec);
135 /// Default destructor
138 /** Loads a script to drive JSBSim (usually in standalone mode).
139 The language is the Simple Script Directives for JSBSim (SSDJ).
140 @param script the filename (including path name, if any) for the script.
141 @return true if successful */
142 bool LoadScript( string script );
144 /** This function is called each pass through the executive Run() method IF
145 scripting is enabled.
146 @return false if script should exit (i.e. if time limits are violated */
147 bool RunScript(void);
163 vector <FGPropertyManager*> TestParam;
164 vector <FGPropertyManager*> SetParam;
165 vector <double> TestValue;
166 vector <double> SetValue;
167 vector <string> Comparison;
169 vector <bool> Persistent;
170 vector <eAction> Action;
172 vector <bool> Triggered;
173 vector <double> newValue;
174 vector <double> OriginalValue;
175 vector <double> StartTime;
176 vector <double> EndTime;
187 vector <struct condition> Conditions;
191 FGPropertyManager* PropertyManager;
192 void Debug(int from);
195 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%