src/FDM/JSBSim/models/flight_control/FGFCSComponent.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGFCSComponent.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 11/1999
   6
   7  ------------- Copyright (C) 2000 -------------
   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 "FGFCSComponent.h"
  41
  42 namespace JSBSim {
  43
  44 static const char *IdSrc = "$Id$";
  45 static const char *IdHdr = ID_FCSCOMPONENT;
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 CLASS IMPLEMENTATION
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51 FGFCSComponent::FGFCSComponent(FGFCS* _fcs, Element* element) : fcs(_fcs)
  52 {
  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;
  60
  61   PropertyManager = fcs->GetPropertyManager();
  62   if        (element->GetName() == string("lag_filter")) {
  63     Type = "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")) {
  71     Type = "INTEGRATOR";
  72   } else if (element->GetName() == string("summer")) {
  73     Type = "SUMMER";
  74   } else if (element->GetName() == string("pure_gain")) {
  75     Type = "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")) {
  81     Type = "SWITCH";
  82   } else if (element->GetName() == string("kinematic")) {
  83     Type = "KINEMATIC";
  84   } else if (element->GetName() == string("deadband")) {
  85     Type = "DEADBAND";
  86   } else if (element->GetName() == string("fcs_function")) {
  87     Type = "FCS_FUNCTION";
  88   } else if (element->GetName() == string("pid")) {
  89     Type = "PID";
  90   } else if (element->GetName() == string("sensor")) {
  91     Type = "SENSOR";
  92   } else if (element->GetName() == string("actuator")) {
  93     Type = "ACTUATOR";
  94   } else { // illegal component in this channel
  95     Type = "UNKNOWN";
  96   }
  97
  98   Name = element->GetAttributeValue("name");
  99
 100   FGPropertyManager *tmp=0;
 101
 102   input_element = element->FindElement("input");
 103   while (input_element) {
 104     input = input_element->GetDataLine();
 105     if (input[0] == '-') {
 106       InputSigns.push_back(-1.0);
 107       input.erase(0,1);
 108     } else {
 109       InputSigns.push_back( 1.0);
 110     }
 111     tmp = PropertyManager->GetNode(input);
 112     if (tmp) {
 113       InputNodes.push_back( tmp );
 114     } else {
 115       cerr << fgred << "  In component: " << Name << " unknown property "
 116            << input << " referenced. Aborting" << endl;
 117       exit(-1);
 118     }
 119     input_element = element->FindNextElement("input");
 120   }
 121
 122   if (element->FindElement("output")) {
 123     IsOutput = true;
 124     OutputNode = PropertyManager->GetNode( element->FindElementValue("output") );
 125     if (!OutputNode) {
 126       cerr << endl << "  Unable to process property: " << element->FindElementValue("output") << endl;
 127       throw(string("Invalid output property name in flight control definition"));
 128     }
 129   }
 130
 131   clip_el = element->FindElement("clipto");
 132   if (clip_el) {
 133     clip_string = clip_el->FindElementValue("min");
 134     if (clip_string.find_first_not_of("+-.0123456789") != string::npos) { // it's a property
 135       if (clip_string[0] == '-') clipMinSign = -1.0;
 136       ClipMinPropertyNode = PropertyManager->GetNode( clip_string );
 137     } else {
 138       clipmin = clip_el->FindElementValueAsNumber("min");
 139     }
 140     clip_string = clip_el->FindElementValue("max");
 141     if (clip_string.find_first_not_of("+-.0123456789") != string::npos) { // it's a property
 142       if (clip_string[0] == '-') clipMaxSign = -1.0;
 143       ClipMaxPropertyNode = PropertyManager->GetNode( clip_string );
 144     } else {
 145       clipmax = clip_el->FindElementValueAsNumber("max");
 146     }
 147     clip = true;
 148   }
 149
 150   Debug(0);
 151 }
 152
 153 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 154
 155 FGFCSComponent::~FGFCSComponent()
 156 {
 157   Debug(1);
 158 }
 159
 160 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 161
 162 void FGFCSComponent::SetOutput(void)
 163 {
 164   OutputNode->setDoubleValue(Output);
 165 }
 166
 167 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 168
 169 bool FGFCSComponent::Run(void)
 170 {
 171   return true;
 172 }
 173
 174 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 175
 176 void FGFCSComponent::Clip(void)
 177 {
 178   if (clip) {
 179     if (ClipMinPropertyNode != 0) clipmin = clipMinSign*ClipMinPropertyNode->getDoubleValue();
 180     if (ClipMaxPropertyNode != 0) clipmax = clipMaxSign*ClipMaxPropertyNode->getDoubleValue();
 181     if (Output > clipmax)      Output = clipmax;
 182     else if (Output < clipmin) Output = clipmin;
 183   }
 184 }
 185
 186 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 187 //
 188 // The old way of naming FCS components allowed upper or lower case, spaces, etc.
 189 // but then the names were modified to fit into a property name heirarchy. This
 190 // was confusing (it wasn't done intentionally - it was a carryover from the early
 191 // design). We now support the direct naming of properties in the FCS component
 192 // name attribute. The old way is supported in code at this time, but deprecated.
 193
 194 void FGFCSComponent::bind(void)
 195 {
 196   string tmp;
 197   if (Name.find("/") == string::npos) {
 198     tmp = "fcs/" + PropertyManager->mkPropertyName(Name, true);
 199   } else {
 200     tmp = Name;
 201   }
 202   PropertyManager->Tie( tmp, this, &FGFCSComponent::GetOutput);
 203 }
 204
 205 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 206 //    The bitmasked value choices are as follows:
 207 //    unset: In this case (the default) JSBSim would only print
 208 //       out the normally expected messages, essentially echoing
 209 //       the config files as they are read. If the environment
 210 //       variable is not set, debug_lvl is set to 1 internally
 211 //    0: This requests JSBSim not to output any messages
 212 //       whatsoever.
 213 //    1: This value explicity requests the normal JSBSim
 214 //       startup messages
 215 //    2: This value asks for a message to be printed out when
 216 //       a class is instantiated
 217 //    4: When this value is set, a message is displayed when a
 218 //       FGModel object executes its Run() method
 219 //    8: When this value is set, various runtime state variables
 220 //       are printed out periodically
 221 //    16: When set various parameters are sanity checked and
 222 //       a message is printed out when they go out of bounds
 223
 224 void FGFCSComponent::Debug(int from)
 225 {
 226   if (debug_lvl <= 0) return;
 227
 228   if (debug_lvl & 1) { // Standard console startup message output
 229     if (from == 0) {
 230       cout << endl << "    Loading Component \"" << Name
 231                    << "\" of type: " << Type << endl;
 232     }
 233   }
 234   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 235     if (from == 0) cout << "Instantiated: FGFCSComponent" << endl;
 236     if (from == 1) cout << "Destroyed:    FGFCSComponent" << endl;
 237   }
 238   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 239   }
 240   if (debug_lvl & 8 ) { // Runtime state variables
 241   }
 242   if (debug_lvl & 16) { // Sanity checking
 243   }
 244   if (debug_lvl & 64) {
 245     if (from == 0) { // Constructor
 246       cout << IdSrc << endl;
 247       cout << IdHdr << endl;
 248     }
 249   }
 250 }
 251 }