INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
-#ifdef FGFS
-# include <simgear/compiler.h>
-# ifdef SG_HAVE_STD_INCLUDES
-# include <vector>
-# else
-# include <vector.h>
-# endif
-#else
-# include <vector>
-#endif
-
-#include <string>
#include "FGFCSComponent.h"
-#include <input_output/FGXMLElement.h>
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DEFINITIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
-#define ID_SUMMER "$Id$"
+#define ID_SUMMER "$Id: FGSummer.h,v 1.9 2009/10/24 22:59:30 jberndt Exp $"
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
namespace JSBSim {
+class Element;
+
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
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:
-<pre>
- \<COMPONENT NAME="name" TYPE="SUMMER">
- INPUT \<property>
- INPUT \<property>
- [BIAS \<value>]
- [?]
- [CLIPTO \<min> \<max> 1]
- [OUTPUT \<property>]
- \</COMPONENT>
-</pre>
+@code
+ <summer name="{string}">
+ <input> {string} </input>
+ <input> {string} </input>
+ <bias> {number} </bias>
+ <clipto>
+ <min> {number} </min>
+ <max> {number} </max>
+ </clipto>
+ <output> {string} </output>
+ </summer>
+@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
+ <summer name="Roll A/P Error summer">
+ <input> velocities/p-rad_sec </input>
+ <input> -fcs/roll-ap-wing-leveler </input>
+ <input> fcs/roll-ap-error-integrator </input>
+ <clipto>
+ <min> -1 </min>
+ <max> 1 </max>
+ </clipto>
+ </summer>
+@endcode
+
<pre>
- \<COMPONENT NAME="Roll A/P Error summer" TYPE="SUMMER">
- INPUT velocities/p-rad_sec
- INPUT -fcs/roll-ap-wing-leveler
- INPUT fcs/roll-ap-error-integrator
- CLIPTO -1 1
- \</COMPONENT>
+ Notes:
+
+ There can be only one BIAS statement per component.
+
+ There may be any number of inputs.
</pre>
- Note that there can be only one BIAS statement per component.
@author Jon S. Berndt
- @version $Id$
+ @version $Id: FGSummer.h,v 1.9 2009/10/24 22:59:30 jberndt Exp $
*/
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
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();