1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 Module: FGFCSComponent.cpp
7 ------------- Copyright (C) 2000 -------------
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
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
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.
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.
26 FUNCTIONAL DESCRIPTION
27 --------------------------------------------------------------------------------
30 --------------------------------------------------------------------------------
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33 COMMENTS, REFERENCES, and NOTES
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40 #include "FGFCSComponent.h"
44 static const char *IdSrc = "$Id$";
45 static const char *IdHdr = ID_FCSCOMPONENT;
47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
51 FGFCSComponent::FGFCSComponent(FGFCS* _fcs, Element* element) : fcs(_fcs)
53 Element *input_element, *clip_el;
54 Input = Output = clipmin = clipmax = 0.0;
55 OutputNode = treenode = 0;
56 ClipMinPropertyNode = ClipMaxPropertyNode = 0;
57 clipMinSign = clipMaxSign = 1.0;
58 IsOutput = clip = false;
59 string input, clip_string;
61 PropertyManager = fcs->GetPropertyManager();
62 if (element->GetName() == string("lag_filter")) {
64 } else if (element->GetName() == string("lead_lag_filter")) {
65 Type = "LEAD_LAG_FILTER";
66 } else if (element->GetName() == string("washout_filter")) {
67 Type = "WASHOUT_FILTER";
68 } else if (element->GetName() == string("second_order_filter")) {
69 Type = "SECOND_ORDER_FILTER";
70 } else if (element->GetName() == string("integrator")) {
72 } else if (element->GetName() == string("summer")) {
74 } else if (element->GetName() == string("pure_gain")) {
76 } else if (element->GetName() == string("scheduled_gain")) {
77 Type = "SCHEDULED_GAIN";
78 } else if (element->GetName() == string("aerosurface_scale")) {
79 Type = "AEROSURFACE_SCALE";
80 } else if (element->GetName() == string("switch")) {
82 } else if (element->GetName() == string("kinematic")) {
84 } else if (element->GetName() == string("deadband")) {
86 } else if (element->GetName() == string("fcs_function")) {
87 Type = "FCS_FUNCTION";
88 } else if (element->GetName() == string("pid")) {
90 } else if (element->GetName() == string("sensor")) {
92 } else { // illegal component in this channel
96 Name = element->GetAttributeValue("name");
98 FGPropertyManager *tmp=0;
100 input_element = element->FindElement("input");
101 while (input_element) {
102 input = input_element->GetDataLine();
103 if (input[0] == '-') {
104 InputSigns.push_back(-1.0);
107 InputSigns.push_back( 1.0);
109 tmp = PropertyManager->GetNode(input);
111 InputNodes.push_back( tmp );
113 cerr << fgred << " In component: " << Name << " unknown property "
114 << input << " referenced. Aborting" << endl;
117 input_element = element->FindNextElement("input");
120 if (element->FindElement("output")) {
122 OutputNode = PropertyManager->GetNode( element->FindElementValue("output") );
124 cerr << endl << " Unable to process property: " << element->FindElementValue("output") << endl;
125 throw(string("Invalid output property name in flight control definition"));
129 clip_el = element->FindElement("clipto");
131 clip_string = clip_el->FindElementValue("min");
132 if (clip_string.find_first_not_of("+-.0123456789") != string::npos) { // it's a property
133 if (clip_string[0] == '-') clipMinSign = -1.0;
134 ClipMinPropertyNode = PropertyManager->GetNode( clip_string );
136 clipmin = clip_el->FindElementValueAsNumber("min");
138 clip_string = clip_el->FindElementValue("max");
139 if (clip_string.find_first_not_of("+-.0123456789") != string::npos) { // it's a property
140 if (clip_string[0] == '-') clipMaxSign = -1.0;
141 ClipMaxPropertyNode = PropertyManager->GetNode( clip_string );
143 clipmax = clip_el->FindElementValueAsNumber("max");
151 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
153 FGFCSComponent::~FGFCSComponent()
158 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
160 void FGFCSComponent::SetOutput(void)
162 OutputNode->setDoubleValue(Output);
165 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
167 bool FGFCSComponent::Run(void)
172 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
174 void FGFCSComponent::Clip(void)
177 if (ClipMinPropertyNode != 0) clipmin = clipMinSign*ClipMinPropertyNode->getDoubleValue();
178 if (ClipMaxPropertyNode != 0) clipmax = clipMaxSign*ClipMaxPropertyNode->getDoubleValue();
179 if (Output > clipmax) Output = clipmax;
180 else if (Output < clipmin) Output = clipmin;
184 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
186 // The old way of naming FCS components allowed upper or lower case, spaces, etc.
187 // but then the names were modified to fit into a property name heirarchy. This
188 // was confusing (it wasn't done intentionally - it was a carryover from the early
189 // design). We now support the direct naming of properties in the FCS component
190 // name attribute. The old way is supported in code at this time, but deprecated.
192 void FGFCSComponent::bind(void)
195 if (Name.find("/") == string::npos) {
196 tmp = "fcs/" + PropertyManager->mkPropertyName(Name, true);
200 PropertyManager->Tie( tmp, this, &FGFCSComponent::GetOutput);
203 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
204 // The bitmasked value choices are as follows:
205 // unset: In this case (the default) JSBSim would only print
206 // out the normally expected messages, essentially echoing
207 // the config files as they are read. If the environment
208 // variable is not set, debug_lvl is set to 1 internally
209 // 0: This requests JSBSim not to output any messages
211 // 1: This value explicity requests the normal JSBSim
213 // 2: This value asks for a message to be printed out when
214 // a class is instantiated
215 // 4: When this value is set, a message is displayed when a
216 // FGModel object executes its Run() method
217 // 8: When this value is set, various runtime state variables
218 // are printed out periodically
219 // 16: When set various parameters are sanity checked and
220 // a message is printed out when they go out of bounds
222 void FGFCSComponent::Debug(int from)
224 if (debug_lvl <= 0) return;
226 if (debug_lvl & 1) { // Standard console startup message output
228 cout << endl << " Loading Component \"" << Name
229 << "\" of type: " << Type << endl;
232 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
233 if (from == 0) cout << "Instantiated: FGFCSComponent" << endl;
234 if (from == 1) cout << "Destroyed: FGFCSComponent" << endl;
236 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
238 if (debug_lvl & 8 ) { // Runtime state variables
240 if (debug_lvl & 16) { // Sanity checking
242 if (debug_lvl & 64) {
243 if (from == 0) { // Constructor
244 cout << IdSrc << endl;
245 cout << IdHdr << endl;