X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FFDM%2FJSBSim%2Fmodels%2Fflight_control%2FFGSummer.h;h=cc11352f50d42d976dbefe65d3f5c3d5f975bdb3;hb=a6db6d89ff41a619569e6433409e8bf62ff98499;hp=8bf5fbbdfb78f2e611e8a1b88e22aafd21ae46d2;hpb=3ec74d79c23347add2afa088b05ad29af975f65f;p=flightgear.git diff --git a/src/FDM/JSBSim/models/flight_control/FGSummer.h b/src/FDM/JSBSim/models/flight_control/FGSummer.h index 8bf5fbbdf..cc11352f5 100644 --- a/src/FDM/JSBSim/models/flight_control/FGSummer.h +++ b/src/FDM/JSBSim/models/flight_control/FGSummer.h @@ -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();