184 lines
6.9 KiB
C++
184 lines
6.9 KiB
C++
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
Header: FGAircraft.h
|
|
Author: Jon S. Berndt
|
|
Date started: 12/12/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/12/98 JSB Created
|
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
SENTRY
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
|
|
|
|
#ifndef FGAIRCRAFT_H
|
|
#define FGAIRCRAFT_H
|
|
|
|
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
INCLUDES
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
|
|
|
|
#ifdef FGFS
|
|
# include <simgear/compiler.h>
|
|
# ifdef SG_HAVE_STD_INCLUDES
|
|
# include <vector>
|
|
# include <iterator>
|
|
# else
|
|
# include <vector.h>
|
|
# include <iterator.h>
|
|
# endif
|
|
#else
|
|
# include <vector>
|
|
# include <iterator>
|
|
#endif
|
|
|
|
#include "FGModel.h"
|
|
#include "FGConfigFile.h"
|
|
#include "FGColumnVector3.h"
|
|
|
|
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
DEFINITIONS
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
|
|
|
|
#define ID_AIRCRAFT "$Id$"
|
|
|
|
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
FORWARD DECLARATIONS
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
|
|
|
|
namespace JSBSim {
|
|
|
|
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
CLASS DOCUMENTATION
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
|
|
|
|
/** Encapsulates an Aircraft and its systems.
|
|
Owns all the parts (other classes) which make up this aircraft. This includes
|
|
the Engines, Tanks, Propellers, Nozzles, Aerodynamic and Mass properties,
|
|
landing gear, etc. These constituent parts may actually run as separate
|
|
JSBSim models themselves, but the responsibility for initializing them and
|
|
for retrieving their force and moment contributions falls to FGAircraft.
|
|
@author Jon S. Berndt
|
|
@version $Id$
|
|
@see Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
|
|
Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420 Naval Postgraduate
|
|
School, January 1994
|
|
@see D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
|
|
JSC 12960, July 1977
|
|
@see Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
|
|
NASA-Ames", NASA CR-2497, January 1975
|
|
@see Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
|
|
Wiley & Sons, 1979 ISBN 0-471-03032-5
|
|
@see Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
|
|
1982 ISBN 0-471-08936-2
|
|
*/
|
|
|
|
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
CLASS DECLARATION
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
|
|
|
|
class FGAircraft : public FGModel {
|
|
public:
|
|
/** Constructor
|
|
@param Executive a pointer to the parent executive object */
|
|
FGAircraft(FGFDMExec *Executive);
|
|
|
|
/// Destructor
|
|
~FGAircraft();
|
|
|
|
/** Runs the Aircraft model; called by the Executive
|
|
@see JSBSim.cpp documentation
|
|
@return false if no error */
|
|
bool Run(void);
|
|
|
|
/** Loads the aircraft.
|
|
The executive calls this method to load the aircraft into JSBSim.
|
|
@param AC_cfg a pointer to the config file instance
|
|
@return true if successful */
|
|
bool Load(FGConfigFile* AC_cfg);
|
|
|
|
/** Gets the aircraft name
|
|
@return the name of the aircraft as a string type */
|
|
inline string GetAircraftName(void) { return AircraftName; }
|
|
|
|
/// Gets the wing area
|
|
double GetWingArea(void) const { return WingArea; }
|
|
/// Gets the wing span
|
|
double GetWingSpan(void) const { return WingSpan; }
|
|
/// Gets the average wing chord
|
|
double Getcbar(void) const { return cbar; }
|
|
inline double GetWingIncidence(void) const { return WingIncidence; }
|
|
inline double GetHTailArea(void) const { return HTailArea; }
|
|
inline double GetHTailArm(void) const { return HTailArm; }
|
|
inline double GetVTailArea(void) const { return VTailArea; }
|
|
inline double GetVTailArm(void) const { return VTailArm; }
|
|
inline double Getlbarh(void) const { return lbarh; } // HTailArm / cbar
|
|
inline double Getlbarv(void) const { return lbarv; } // VTailArm / cbar
|
|
inline double Getvbarh(void) const { return vbarh; } // H. Tail Volume
|
|
inline double Getvbarv(void) const { return vbarv; } // V. Tail Volume
|
|
inline FGColumnVector3& GetMoments(void) { return vMoments; }
|
|
inline double GetMoments(int idx) const { return vMoments(idx); }
|
|
inline FGColumnVector3& GetForces(void) { return vForces; }
|
|
inline double GetForces(int idx) const { return vForces(idx); }
|
|
inline FGColumnVector3& GetBodyAccel(void) { return vBodyAccel; }
|
|
inline double GetBodyAccel(int idx) { return vBodyAccel(idx); }
|
|
inline FGColumnVector3& GetNcg (void) { return vNcg; }
|
|
inline double GetNcg(int idx) { return vNcg(idx); }
|
|
inline FGColumnVector3& GetXYZrp(void) { return vXYZrp; }
|
|
inline FGColumnVector3& GetXYZvrp(void) { return vXYZvrp; }
|
|
inline FGColumnVector3& GetXYZep(void) { return vXYZep; }
|
|
inline double GetXYZrp(int idx) const { return vXYZrp(idx); }
|
|
inline double GetXYZvrp(int idx) const { return vXYZvrp(idx); }
|
|
inline double GetXYZep(int idx) const { return vXYZep(idx); }
|
|
inline void SetAircraftName(string name) {AircraftName = name;}
|
|
|
|
float GetNlf(void);
|
|
|
|
inline FGColumnVector3& GetNwcg(void) { return vNwcg; }
|
|
|
|
void bind(void);
|
|
void unbind(void);
|
|
|
|
private:
|
|
FGColumnVector3 vMoments;
|
|
FGColumnVector3 vForces;
|
|
FGColumnVector3 vXYZrp;
|
|
FGColumnVector3 vXYZvrp;
|
|
FGColumnVector3 vXYZep;
|
|
FGColumnVector3 vDXYZcg;
|
|
FGColumnVector3 vBodyAccel;
|
|
FGColumnVector3 vNcg;
|
|
FGColumnVector3 vNwcg;
|
|
|
|
double WingArea, WingSpan, cbar, WingIncidence;
|
|
double HTailArea, VTailArea, HTailArm, VTailArm;
|
|
double lbarh,lbarv,vbarh,vbarv;
|
|
string AircraftName;
|
|
|
|
void Debug(int from);
|
|
};
|
|
|
|
} // namespace JSBSim
|
|
//%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
#endif
|
|
|