FGAircraft Class Reference

#include <FGAircraft.h>

Inherits FGModel.

List of all members.


Detailed Description

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.

The <metrics> section of the aircraft configuration file is read here, and the metrical information is held by this class.

Configuration File Format for <metrics> Section:

    <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>

Author:
Jon S. Berndt
Version:
Id
FGAircraft.h,v 1.12 2008/11/30 16:56:03 jberndt Exp
See also:
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

D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices", JSC 12960, July 1977

Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at NASA-Ames", NASA CR-2497, January 1975

Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics", Wiley & Sons, 1979 ISBN 0-471-03032-5

Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons, 1982 ISBN 0-471-08936-2

Definition at line 110 of file FGAircraft.h.


Public Member Functions

void bind (void)
 FGAircraft (FGFDMExec *Executive)
 Constructor.
string GetAircraftName (void)
 Gets the aircraft name.
double GetBodyAccel (int idx)
FGColumnVector3GetBodyAccel (void)
double Getcbar (void) const
 Gets the average wing chord.
double GetForces (int idx) const
FGColumnVector3GetForces (void)
int GetHoldDown (void) const
double GetHTailArea (void) const
double GetHTailArm (void) const
double Getlbarh (void) const
double Getlbarv (void) const
double GetMoments (int idx) const
FGColumnVector3GetMoments (void)
double GetNcg (int idx)
FGColumnVector3GetNcg (void)
double GetNlf (void) const
FGColumnVector3GetNwcg (void)
double Getvbarh (void) const
double Getvbarv (void) const
double GetVTailArea (void) const
double GetVTailArm (void) const
double GetWingArea (void) const
 Gets the wing area.
double GetWingIncidence (void) const
double GetWingIncidenceDeg (void) const
double GetWingSpan (void) const
 Gets the wing span.
double GetXYZep (int idx) const
FGColumnVector3GetXYZep (void)
double GetXYZrp (int idx) const
FGColumnVector3GetXYZrp (void)
double GetXYZvrp (int idx) const
FGColumnVector3GetXYZvrp (void)
bool InitModel (void)
bool Load (Element *el)
 Loads the aircraft.
bool Run (void)
 Runs the Aircraft model; called by the Executive.
void SetAircraftName (string name)
void SetHoldDown (int hd)
void SetWingArea (double S)
void SetXYZrp (int idx, double value)
void unbind (void)
 ~FGAircraft ()
 Destructor.

Constructor & Destructor Documentation

FGAircraft ( FGFDMExec Executive  ) 

Parameters:
Executive a pointer to the parent executive object

Definition at line 74 of file FGAircraft.cpp.


Member Function Documentation

string GetAircraftName ( void   )  [inline]

Returns:
the name of the aircraft as a string type

Definition at line 134 of file FGAircraft.h.

bool Load ( Element el  )  [virtual]

The executive calls this method to load the aircraft into JSBSim.

Parameters:
el a pointer to the element tree
Returns:
true if successful

Reimplemented from FGModel.

Definition at line 150 of file FGAircraft.cpp.

bool Run ( void   )  [virtual]

See also:
JSBSim.cpp documentation
Returns:
false if no error

Reimplemented from FGModel.

Definition at line 108 of file FGAircraft.cpp.


The documentation for this class was generated from the following files:

Generated on Tue May 26 00:55:09 2009 for JSBSim Flight Dynamics Model by  doxygen 1.5.5