Sync. with JSBSim (CVS) again

[flightgear.git] / src / FDM / JSBSim / models / flight_control / FGFCSFunction.h

diff --git a/src/FDM/JSBSim/models/flight_control/FGFCSFunction.h b/src/FDM/JSBSim/models/flight_control/FGFCSFunction.h
index 9f1c5317e967d7aa555bf4ac566c406ed95158d6..422d0b0930e9bead004bc09759b82ac32f0d420c 100755 (executable)
--- a/src/FDM/JSBSim/models/flight_control/FGFCSFunction.h
+++ b/src/FDM/JSBSim/models/flight_control/FGFCSFunction.h
@@ -7,20 +7,20 @@
  ------------- Copyright (C) 2005 Jon S. Berndt -------------
 
  This program is free software; you can redistribute it and/or modify it under
- the terms of the GNU General Public License as published by the Free Software
+ the terms of the GNU Lesser General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.
 
  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  details.
 
- You should have received a copy of the GNU General Public License along with
+ You should have received a copy of the GNU Lesser General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  Place - Suite 330, Boston, MA  02111-1307, USA.
 
- Further information about the GNU General Public License can also be found on
+ Further information about the GNU Lesser General Public License can also be found on
  the world wide web at http://www.gnu.org.
 
 HISTORY
@@ -61,6 +61,50 @@ CLASS DOCUMENTATION
 
 /** Models a FCSFunction object.
     @author Jon S. Berndt
+
+One of the most recent additions to the FCS component set is the FCS Function
+component. This component allows a function to be created when no other component
+is suitable. Available mathematical operations are described in the FGFunction class.  
+The function component is defined as follows:
+
+@code
+<fcs_function name="Windup Trigger">
+  [<input> [-]property </input>]
+  <function>
+    ...
+  </function>
+  [<clipto>
+    <min> {[-]property name | value} </min>
+    <max> {[-]property name | value} </max>
+  </clipto>]
+  [<output> {property} </output>]
+</ fcs_function >
+@endcode
+
+The function definition itself can include a nested series of products, sums,
+quotients, etc. as well as trig and other math functions. Here's an example of
+a function (from an aero specification):
+
+@code
+<function name="aero/coefficient/CDo">
+    <description>Drag_at_zero_lift</description>
+    <product>
+        <property>aero/qbar-psf</property>
+        <property>metrics/Sw-sqft</property>
+        <table>
+            <independentVar>velocities/mach</independentVar>
+            <tableData>
+                0.0000 0.0220
+                0.2000 0.0200
+                0.6500 0.0220
+                0.9000 0.0240
+                0.9700 0.0500
+            </tableData>
+        </table>
+    </product>
+</function>
+@endcode
+
     @version $Id$
 */