]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/models/flight_control/FGFCSFunction.cpp
Hide some user generated files.
[flightgear.git] / src / FDM / JSBSim / models / flight_control / FGFCSFunction.cpp
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2
3  Module:       FGFCSFunction.cpp
4  Author:       Jon S. Berndt
5  Date started: 6/2005
6
7  ------------- Copyright (C) 2005 -------------
8
9  This program is free software; you can redistribute it and/or modify it under
10  the terms of the GNU 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 General Public License for more
17  details.
18
19  You should have received a copy of the GNU 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 General Public License can also be found on
24  the world wide web at http://www.gnu.org.
25
26 FUNCTIONAL DESCRIPTION
27 --------------------------------------------------------------------------------
28
29 HISTORY
30 --------------------------------------------------------------------------------
31
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33 COMMENTS, REFERENCES,  and NOTES
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
35
36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
37 INCLUDES
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
39
40 #include "FGFCSFunction.h"
41
42 namespace JSBSim {
43
44 static const char *IdSrc = "$Id$";
45 static const char *IdHdr = ID_FCSFUNCTION;
46
47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
48 CLASS IMPLEMENTATION
49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
50
51 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
52
53 FGFCSFunction::FGFCSFunction(FGFCS* fcs, Element* element) : FGFCSComponent(fcs, element)
54 {
55   Element *function_element = element->FindElement("function");
56
57   function = new FGFunction(PropertyManager, function_element);
58
59   FGFCSComponent::bind();
60   Debug(0);
61 }
62
63 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
64
65 FGFCSFunction::~FGFCSFunction()
66 {
67   Debug(1);
68 }
69
70 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
71
72 bool FGFCSFunction::Run(void )
73 {
74   Output = function->GetValue();
75
76   if (InputNodes.size() > 0) {
77     Input = InputNodes[0]->getDoubleValue() * InputSigns[0];
78     Output*= Input;
79   }
80
81   Clip();
82
83   if (IsOutput) SetOutput();
84
85   return true;
86 }
87
88 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
89 //    The bitmasked value choices are as follows:
90 //    unset: In this case (the default) JSBSim would only print
91 //       out the normally expected messages, essentially echoing
92 //       the config files as they are read. If the environment
93 //       variable is not set, debug_lvl is set to 1 internally
94 //    0: This requests JSBSim not to output any messages
95 //       whatsoever.
96 //    1: This value explicity requests the normal JSBSim
97 //       startup messages
98 //    2: This value asks for a message to be printed out when
99 //       a class is instantiated
100 //    4: When this value is set, a message is displayed when a
101 //       FGModel object executes its Run() method
102 //    8: When this value is set, various runtime state variables
103 //       are printed out periodically
104 //    16: When set various parameters are sanity checked and
105 //       a message is printed out when they go out of bounds
106
107 void FGFCSFunction::Debug(int from)
108 {
109   if (debug_lvl <= 0) return;
110
111   if (debug_lvl & 1) { // Standard console startup message output
112     if (from == 0) { // Constructor
113       if (InputNodes.size()>0)
114         cout << "      INPUT: " << InputNodes[0]->getName() << endl;
115 //    cout << "      Function: " << endl;
116       if (clip) cout << "      CLIPTO: " << clipmin
117                                   << ", " << clipmax << endl;
118       if (IsOutput) cout << "      OUTPUT: " << OutputNode->getName() << endl;
119     }
120   }
121   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
122     if (from == 0) cout << "Instantiated: FGFCSFunction" << endl;
123     if (from == 1) cout << "Destroyed:    FGFCSFunction" << endl;
124   }
125   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
126   }
127   if (debug_lvl & 8 ) { // Runtime state variables
128   }
129   if (debug_lvl & 16) { // Sanity checking
130   }
131   if (debug_lvl & 64) {
132     if (from == 0) { // Constructor
133       cout << IdSrc << endl;
134       cout << IdHdr << endl;
135     }
136   }
137 }
138 }