/*******************************************************************************

 Header:       FGCoefficient.h
 Author:       Jon Berndt
 Date started: 12/28/98

 ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free Software
 Foundation; either version 2 of the License, or (at your option) any later
 version.

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 details.

 You should have received a copy of the GNU General Public License along with
 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 Place - Suite 330, Boston, MA  02111-1307, USA.

 Further information about the GNU General Public License can also be found on
 the world wide web at http://www.gnu.org.

HISTORY
--------------------------------------------------------------------------------
12/28/98   JSB   Created

********************************************************************************
SENTRY
*******************************************************************************/

#ifndef FGCOEFFICIENT_H
#define FGCOEFFICIENT_H

/*******************************************************************************
INCLUDES
*******************************************************************************/
#ifdef FGFS
#  include <simgear/compiler.h>
#  include STL_STRING
   FG_USING_STD(string);
#else
#  include <string>
#endif

#include <map>
#include "FGConfigFile.h"
#include "FGDefs.h"

/*******************************************************************************
DEFINES
*******************************************************************************/

using namespace std;

/*******************************************************************************
FORWARD DECLARATIONS
*******************************************************************************/
class FGFDMExec;
class FGState;
class FGAtmosphere;
class FGFCS;
class FGAircraft;
class FGTranslation;
class FGRotation;
class FGPosition;
class FGAuxiliary;
class FGOutput;

/*******************************************************************************
COMMENTS, REFERENCES,  and NOTES
********************************************************************************

This class models the stability derivative coefficient lookup tables or 
equations. Note that the coefficients need not be calculated each delta-t.

FG_QBAR           1
FG_WINGAREA       2
FG_WINGSPAN       4
FG_CBAR           8
FG_ALPHA          16
FG_ALPHADOT       32
FG_BETA           64
FG_BETADOT        128
FG_PITCHRATE      256
FG_ROLLRATE       512
FG_YAWRATE        1024
FG_MACH           2048
FG_ALTITUDE       4096
FG_BI2VEL         8192
FG_CI2VEL         16384
FG_ELEVATOR_POS   32768L
FG_AILERON_POS    65536L
FG_RUDDER_POS     131072L
FG_SPDBRAKE_POS   262144L
FG_FLAPS_POS      524288L
FG_ELEVATOR_CMD   1048576L
FG_AILERON_CMD    2097152L
FG_RUDDER_CMD     4194304L
FG_SPDBRAKE_CMD   8388608L
FG_FLAPS_CMD      16777216L
FG_SPARE1         33554432L
FG_SPARE2         67108864L
FG_SPARE3         134217728L
FG_SPARE4         268435456L
FG_SPARE5         536870912L
FG_SPARE6         1073741824L

The above definitions are found in FGDefs.h

********************************************************************************
CLASS DECLARATION
*******************************************************************************/

class FGCoefficient
{
public:
  FGCoefficient(FGFDMExec*, FGConfigFile*);
  ~FGCoefficient(void);
  bool Allocate(int);
  bool Allocate(int, int);
  float Value(float, float);
  float Value(float);
  float Value(void);
  float TotalValue(void);
  inline string Getname(void) {return name;}
  inline float GetSD(void) {return SD;}
//  inline float GetSDValue(void) {return SD;}
//  inline void SetSDValue(float tt) {SD = tt;}
  inline long int Getmultipliers(void) {return multipliers;}
  void DumpSD(void);
  enum Type {UNKNOWN, VALUE, VECTOR, TABLE, EQUATION};

protected:

private:
  int numInstances;
  string filename;
  string description;
  string name;
  string method;
  float StaticValue;
  float *Table2D;
  float **Table3D;
  float LookupR, LookupC;
  long int multipliers;
  long int mult_idx[10];
  int rows, columns;
  Type type;
  int mult_count;
  float SD; // Actual stability derivative (or other coefficient) value

  FGFDMExec*      FDMExec;
  FGState*        State;
  FGAtmosphere*   Atmosphere;
  FGFCS*          FCS;
  FGAircraft*     Aircraft;
  FGTranslation*  Translation;
  FGRotation*     Rotation;
  FGPosition*     Position;
  FGAuxiliary*    Auxiliary;
  FGOutput*       Output;
};

/******************************************************************************/
#endif