]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/models/flight_control/FGFCSFunction.cpp
sync. with JSBSim again
[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 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 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   if (function_element)
58     function = new FGFunction(PropertyManager, function_element);
59   else {
60     cerr << "FCS Function should contain a \"function\" element" << endl;
61     exit(-1);
62   }
63
64   FGFCSComponent::bind();
65   Debug(0);
66 }
67
68 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
69
70 FGFCSFunction::~FGFCSFunction()
71 {
72   delete function;
73   Debug(1);
74 }
75
76 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
77
78 bool FGFCSFunction::Run(void )
79 {
80   Output = function->GetValue();
81
82   if (InputNodes.size() > 0) {
83     Input = InputNodes[0]->getDoubleValue() * InputSigns[0];
84     Output*= Input;
85   }
86
87   Clip();
88
89   if (IsOutput) SetOutput();
90
91   return true;
92 }
93
94 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
95 //    The bitmasked value choices are as follows:
96 //    unset: In this case (the default) JSBSim would only print
97 //       out the normally expected messages, essentially echoing
98 //       the config files as they are read. If the environment
99 //       variable is not set, debug_lvl is set to 1 internally
100 //    0: This requests JSBSim not to output any messages
101 //       whatsoever.
102 //    1: This value explicity requests the normal JSBSim
103 //       startup messages
104 //    2: This value asks for a message to be printed out when
105 //       a class is instantiated
106 //    4: When this value is set, a message is displayed when a
107 //       FGModel object executes its Run() method
108 //    8: When this value is set, various runtime state variables
109 //       are printed out periodically
110 //    16: When set various parameters are sanity checked and
111 //       a message is printed out when they go out of bounds
112
113 void FGFCSFunction::Debug(int from)
114 {
115   if (debug_lvl <= 0) return;
116
117   if (debug_lvl & 1) { // Standard console startup message output
118     if (from == 0) { // Constructor
119       if (InputNodes.size()>0)
120         cout << "      INPUT: " << InputNodes[0]->getName() << endl;
121 //    cout << "      Function: " << endl;
122       if (IsOutput) cout << "      OUTPUT: " << OutputNode->getName() << endl;
123     }
124   }
125   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
126     if (from == 0) cout << "Instantiated: FGFCSFunction" << endl;
127     if (from == 1) cout << "Destroyed:    FGFCSFunction" << endl;
128   }
129   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
130   }
131   if (debug_lvl & 8 ) { // Runtime state variables
132   }
133   if (debug_lvl & 16) { // Sanity checking
134   }
135   if (debug_lvl & 64) {
136     if (from == 0) { // Constructor
137       cout << IdSrc << endl;
138       cout << IdHdr << endl;
139     }
140   }
141 }
142 }