]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/models/flight_control/FGSummer.h
Merge branch 'ehofman/sky'
[flightgear.git] / src / FDM / JSBSim / models / flight_control / FGSummer.h
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2
3  Header:       FGSummer.h
4  Author:
5  Date started:
6
7  ------------- Copyright (C)  -------------
8
9  This program is free software; you can redistribute it and/or modify it under
10  the terms of the GNU Lesser General Public License as published by the Free Software
11  Foundation; either version 2 of the License, or (at your option) any later
12  version.
13
14  This program is distributed in the hope that it will be useful, but WITHOUT
15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
17  details.
18
19  You should have received a copy of the GNU Lesser General Public License along with
20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
21  Place - Suite 330, Boston, MA  02111-1307, USA.
22
23  Further information about the GNU Lesser General Public License can also be found on
24  the world wide web at http://www.gnu.org.
25
26 HISTORY
27 --------------------------------------------------------------------------------
28
29 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30 SENTRY
31 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
32
33 #ifndef FGSUMMER_H
34 #define FGSUMMER_H
35
36 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
37 INCLUDES
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
39
40 #include "FGFCSComponent.h"
41
42 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
43 DEFINITIONS
44 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
45
46 #define ID_SUMMER "$Id$"
47
48 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
49 FORWARD DECLARATIONS
50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
51
52 namespace JSBSim {
53
54 class Element;
55
56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
57 CLASS DOCUMENTATION
58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
59
60 /** Models a flight control system summing component.
61     The Summer component sums two or more inputs. These can be pilot control
62     inputs or state variables, and a bias can also be added in using the BIAS
63     keyword.  The form of the summer component specification is:
64 @code
65     <summer name="{string}">
66       <input> {string} </input>
67       <input> {string} </input>
68       <bias> {number} </bias>
69       <clipto>
70          <min> {number} </min>
71          <max> {number} </max>
72       </clipto>
73       <output> {string} </output>
74     </summer>
75 @endcode
76
77     Note that in the case of an input property the property name may be
78     immediately preceded by a minus sign. Here's an example of a summer
79     component specification:
80
81 @code
82     <summer name="Roll A/P Error summer">
83       <input> velocities/p-rad_sec </input>
84       <input> -fcs/roll-ap-wing-leveler </input>
85       <input> fcs/roll-ap-error-integrator </input>
86       <clipto>
87          <min> -1 </min>
88          <max>  1 </max> 
89       </clipto>
90     </summer>
91 @endcode
92
93 <pre>
94     Notes:
95
96     There can be only one BIAS statement per component.
97
98     There may be any number of inputs.
99 </pre>
100
101     @author Jon S. Berndt
102     @version $Id$
103 */
104
105 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
106 CLASS DECLARATION
107 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
108
109 class FGSummer  : public FGFCSComponent
110 {
111 public:
112   /** Constructor.
113       @param fcs a pointer to the parent FGFCS object.
114       @param element a pointer to the configuration file node. */
115   FGSummer(FGFCS* fcs, Element* element);
116   /// Destructor
117   ~FGSummer();
118
119   /// The execution method for this FCS component.
120   bool Run(void);
121
122 private:
123   double Bias;
124   void Debug(int from);
125 };
126 }
127 #endif