X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FFDM%2FJSBSim%2Fmodels%2Fflight_control%2FFGSummer.h;h=cc11352f50d42d976dbefe65d3f5c3d5f975bdb3;hb=a6db6d89ff41a619569e6433409e8bf62ff98499;hp=ede4b261fc783c7f3b450107e218bfd6921aa256;hpb=932b38a87e2870d23f9be9461b551f1e1fe556ba;p=flightgear.git diff --git a/src/FDM/JSBSim/models/flight_control/FGSummer.h b/src/FDM/JSBSim/models/flight_control/FGSummer.h index ede4b261f..cc11352f5 100644 --- a/src/FDM/JSBSim/models/flight_control/FGSummer.h +++ b/src/FDM/JSBSim/models/flight_control/FGSummer.h @@ -7,20 +7,20 @@ ------------- Copyright (C) ------------- 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 @@ -37,20 +37,10 @@ SENTRY INCLUDES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/ -#ifdef FGFS -# include -# ifdef SG_HAVE_STD_INCLUDES -# include -# else -# include -# endif -#else -# include -#endif - -#include #include "FGFCSComponent.h" #include +#include +#include /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% DEFINITIONS @@ -58,6 +48,12 @@ DEFINITIONS #define ID_SUMMER "$Id$" +using std::vector; +using std::string; + +using std::vector; +using std::string; + /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% FORWARD DECLARATIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/ @@ -72,28 +68,42 @@ CLASS DOCUMENTATION The Summer component sums two or more inputs. These can be pilot control inputs or state variables, and a bias can also be added in using the BIAS keyword. The form of the summer component specification is: -
-    \
-      INPUT \
-      INPUT \
-      [BIAS \]
-      [?]
-      [CLIPTO \ \ 1]
-      [OUTPUT \]
-    \
-
+@code + + {string} + {string} + {number} + + {number} + {number} + + {string} + +@endcode + Note that in the case of an input property the property name may be immediately preceded by a minus sign. Here's an example of a summer component specification: + +@code + + velocities/p-rad_sec + -fcs/roll-ap-wing-leveler + fcs/roll-ap-error-integrator + + -1 + 1 + + +@endcode +
-    \
-      INPUT  velocities/p-rad_sec
-      INPUT -fcs/roll-ap-wing-leveler
-      INPUT  fcs/roll-ap-error-integrator
-      CLIPTO -1 1
-    \
+    Notes:
+
+    There can be only one BIAS statement per component.
+
+    There may be any number of inputs.
 
- Note that there can be only one BIAS statement per component. @author Jon S. Berndt @version $Id$ @@ -108,7 +118,7 @@ class FGSummer : public FGFCSComponent public: /** Constructor. @param fcs a pointer to the parent FGFCS object. - @param AC_cfg a pointer to the configuration file object. */ + @param element a pointer to the configuration file node. */ FGSummer(FGFCS* fcs, Element* element); /// Destructor ~FGSummer();