Check return value of FDM::init().

[flightgear.git] / src / FDM / JSBSim / FGAircraft.h

diff --git a/src/FDM/JSBSim/FGAircraft.h b/src/FDM/JSBSim/FGAircraft.h
index 46972cc5fc503f7661e641f37875a07ee6ba179d..b8fe04ca59eea2a4102ba2fb9089aaf9f87c4474 100644 (file)
--- a/src/FDM/JSBSim/FGAircraft.h
+++ b/src/FDM/JSBSim/FGAircraft.h
@@ -133,6 +133,18 @@ DEFINITIONS
     aerodynamic and mass properties, landing gear, etc.
     @author Jon S. Berndt
     @version $Id$
+    @see
+     [1] 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
+     [2] D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
+     JSC 12960, July 1977
+     [3] Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
+     NASA-Ames", NASA CR-2497, January 1975
+     [4] Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
+     Wiley & Sons, 1979 ISBN 0-471-03032-5
+     [5] Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
+     1982 ISBN 0-471-08936-2
   */
 
 /*******************************************************************************
@@ -150,6 +162,7 @@ public:
       @param Executive a pointer to the parent executive object
     */
   FGAircraft(FGFDMExec *Executive);
+  
   /// Destructor
   ~FGAircraft(void);
 
@@ -158,6 +171,7 @@ public:
       @return bool returns false if no error
     */
   bool Run(void);
+  
   /** Loads the aircraft.
       The executive calls this method to load the aircraft into JSBSim.
       @param apath path to the aircraft files (e.g. "aircraft/X15/")
@@ -166,7 +180,12 @@ public:
       @return true if succesful
     */
   bool LoadAircraft(string apath, string epath, string acname);
+  
+  /** Retrieves the aircraft name
+      @return the name of the aircraft as a string type
+    */
   inline string GetAircraftName(void) { return AircraftName; }
+  
   inline void SetGearUp(bool tt) { GearUp = tt; }
   inline bool GetGearUp(void) { return GearUp; }
   inline int GetNumGearUnits(void) { return lGear.size(); }