/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
+
Header: FGAircraft.h
Author: Jon S. Berndt
Date started: 12/12/98
-
- ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
-
+
+ ------------- Copyright (C) 1999 Jon S. Berndt (jon@jsbsim.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
+ the terms of the GNU Lesser 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
+ FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
-
- You should have received a copy of the GNU General Public License along with
+
+ You should have received a copy of the GNU Lesser 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
+ Further information about the GNU Lesser General Public License can also be found on
the world wide web at http://www.gnu.org.
-
+
HISTORY
--------------------------------------------------------------------------------
12/12/98 JSB Created
-
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
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 <string>
+#include <vector>
#include "FGModel.h"
-#include <input_output/FGXMLElement.h>
-#include <math/FGColumnVector3.h>
+#include "input_output/FGXMLElement.h"
+#include "math/FGColumnVector3.h"
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DEFINITIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
-#define ID_AIRCRAFT "$Id$"
+#define ID_AIRCRAFT "$Id: FGAircraft.h,v 1.16 2010/11/18 12:38:06 jberndt Exp $"
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
/** Encapsulates an Aircraft and its systems.
- Owns all the parts (other classes) which make up this aircraft. This includes
+<p> 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.
+<p> The \<metrics> section of the aircraft configuration file is read here, and
+ the metrical information is held by this class.
+<h3>Configuration File Format for \<metrics> Section:</h3>
+@code
+ <metrics>
+ <wingarea unit="{FT2 | M2}"> {number} </wingarea>
+ <wingspan unit="{FT | M}"> {number} </wingspan>
+ <chord unit="{FT | M}"> {number} </chord>
+ <htailarea unit="{FT2 | M2}"> {number} </htailarea>
+ <htailarm unit="{FT | M}"> {number} </htailarm>
+ <vtailarea unit="{FT2 | M}"> {number} </vtailarea>
+ <vtailarm unit="{FT | M}"> {number} </vtailarm>
+ <wing_incidence unit="{RAD | DEG}"> {number} </wing_incidence>
+ <location name="{AERORP | EYEPOINT | VRP}" unit="{IN | M}">
+ <x> {number} </x>
+ <y> {number} </y>
+ <z> {number} </z>
+ </location>
+ {other location blocks}
+ </metrics>
+@endcode
+
@author Jon S. Berndt
- @version $Id$
+ @version $Id: FGAircraft.h,v 1.16 2010/11/18 12:38:06 jberndt Exp $
@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
/** Constructor
@param Executive a pointer to the parent executive object */
FGAircraft(FGFDMExec *Executive);
-
+
/// Destructor
~FGAircraft();
@see JSBSim.cpp documentation
@return false if no error */
bool Run(void);
-
+
+ bool InitModel(void);
+
/** Loads the aircraft.
The executive calls this method to load the aircraft into JSBSim.
@param el a pointer to the element tree
@return true if successful */
bool Load(Element* el);
-
+
/** Gets the aircraft name
@return the name of the aircraft as a string type */
- inline string GetAircraftName(void) { return AircraftName; }
-
+ const std::string& GetAircraftName(void) const { 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;}
-
- double GetNlf(void);
-
- inline FGColumnVector3& GetNwcg(void) { return vNwcg; }
+ double GetWingIncidence(void) const { return WingIncidence; }
+ double GetWingIncidenceDeg(void) const { return WingIncidence*radtodeg; }
+ double GetHTailArea(void) const { return HTailArea; }
+ double GetHTailArm(void) const { return HTailArm; }
+ double GetVTailArea(void) const { return VTailArea; }
+ double GetVTailArm(void) const { return VTailArm; }
+ double Getlbarh(void) const { return lbarh; } // HTailArm / cbar
+ double Getlbarv(void) const { return lbarv; } // VTailArm / cbar
+ double Getvbarh(void) const { return vbarh; } // H. Tail Volume
+ double Getvbarv(void) const { return vbarv; } // V. Tail Volume
+ const FGColumnVector3& GetMoments(void) const { return vMoments; }
+ double GetMoments(int idx) const { return vMoments(idx); }
+ const FGColumnVector3& GetForces(void) const { return vForces; }
+ double GetForces(int idx) const { return vForces(idx); }
+ FGColumnVector3& GetBodyAccel(void) { return vBodyAccel; }
+ double GetBodyAccel(int idx) const { return vBodyAccel(idx); }
+ const FGColumnVector3& GetNcg(void) const { return vNcg; }
+ double GetNcg(int idx) const { return vNcg(idx); }
+ const FGColumnVector3& GetXYZrp(void) const { return vXYZrp; }
+ const FGColumnVector3& GetXYZvrp(void) const { return vXYZvrp; }
+ const FGColumnVector3& GetXYZep(void) const { return vXYZep; }
+ double GetXYZrp(int idx) const { return vXYZrp(idx); }
+ double GetXYZvrp(int idx) const { return vXYZvrp(idx); }
+ double GetXYZep(int idx) const { return vXYZep(idx); }
+ void SetAircraftName(const std::string& name) {AircraftName = name;}
+ void SetHoldDown(int hd) {HoldDown = hd;}
+ int GetHoldDown(void) const {return HoldDown;}
+
+ void SetXYZrp(int idx, double value) {vXYZrp(idx) = value;}
+
+ void SetWingArea(double S) {WingArea = S;}
+
+ double GetNlf(void) const;
+
+ FGColumnVector3& GetNwcg(void) { return vNwcg; }
void bind(void);
void unbind(void);
double WingArea, WingSpan, cbar, WingIncidence;
double HTailArea, VTailArea, HTailArm, VTailArm;
double lbarh,lbarv,vbarh,vbarv;
- string AircraftName;
+ int HoldDown;
+ std::string AircraftName;
void Debug(int from);
};
projects / flightgear.git / blobdiff