src/FDM/JSBSim/FGFactorGroup.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGFactorGroup.h
   4  Author:       Tony Peden
   5  Date started: 7/14/01
   6
   7  ------------- Copyright (C) 2001  Tony Peden (apeden@earthlink.net ------------
   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 HISTORY
  27 --------------------------------------------------------------------------------
  28 12/28/98   JSB   Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGFACTORGROUP_H
  35 #define FGFACTORGROUP_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #ifdef FGFS
  42 #  include <simgear/compiler.h>
  43 #endif
  44
  45 #include <vector>
  46 #include <string>
  47 #include "FGConfigFile.h"
  48 #include "FGDefs.h"
  49 #include "FGTable.h"
  50 #include "FGCoefficient.h"
  51 #include "FGAerodynamics.h"
  52 #include "FGFactorGroup.h"
  53
  54 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  55 DEFINITIONS
  56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  57
  58 #define ID_FACTORGROUP "$Id$"
  59
  60 using std::vector;
  61
  62 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  63 FORWARD DECLARATIONS
  64 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  65
  66 class FGFDMExec;
  67 class FGState;
  68 class FGAtmosphere;
  69 class FGFCS;
  70 class FGAircraft;
  71 class FGTranslation;
  72 class FGRotation;
  73 class FGPosition;
  74 class FGAuxiliary;
  75 class FGOutput;
  76
  77 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  78 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  79 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  80
  81
  82 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  83 CLASS DOCUMENTATION
  84 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  85
  86 /** This class encapsulates the functionality needed to manage a factor group
  87     i.e. factor*(coeff1 + coeff2 + coeff3)
  88     @author Tony Peden
  89     @see -
  90 */
  91
  92 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  93 CLASS DECLARATION
  94 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  95
  96 class FGFactorGroup: public FGCoefficient {
  97   public:
  98     FGFactorGroup(FGFDMExec* fdmex);
  99     ~FGFactorGroup();
 100
 101     bool Load(FGConfigFile *AC_cfg);
 102     float TotalValue(void);
 103     string GetCoefficientStrings(void);
 104     string GetCoefficientValues(void);
 105     inline float GetSD(void) { return SDtotal; };
 106     inline float GetFactorSD(void) { return FGCoefficient::GetSD(); }
 107
 108   private:
 109     FGFDMExec *FDMExec;
 110     string name;
 111     string description;
 112     typedef vector<FGCoefficient*> CoeffArray;
 113     CoeffArray sum;
 114     float SDtotal;
 115
 116 };
 117
 118 #endif