Detailed Description

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.

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

Definition at line 102 of file FGAircraft.h.

#include <FGAircraft.h>

Inheritance diagram for FGAircraft:

Collaboration diagram for FGAircraft:

Classes
struct	Inputs

Public Member Functions
	FGAircraft (FGFDMExec *Executive)
	Constructor. More...

	~FGAircraft () override
	Destructor.

const std::string &	GetAircraftName (void) const
	Gets the aircraft name. More...

double	Getcbar (void) const
	Gets the average wing chord.

double	GetForces (int idx) const

const FGColumnVector3 &	GetForces (void) const

double	GetHTailArea (void) const

double	GetHTailArm (void) const

double	Getlbarh (void) const

double	Getlbarv (void) const

double	GetMoments (int idx) const

const FGColumnVector3 &	GetMoments (void) const

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

const FGColumnVector3 &	GetXYZep (void) const

double	GetXYZrp (int idx) const

const FGColumnVector3 &	GetXYZrp (void) const
	Gets the the aero reference point (RP) coordinates. More...

double	GetXYZvrp (int idx) const

const FGColumnVector3 &	GetXYZvrp (void) const

bool	InitModel (void) override

bool	Load (Element *el) override
	Loads the aircraft. More...

bool	Run (bool Holding) override
	Runs the Aircraft model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold. More...

void	SetAircraftName (const std::string &name)

void	SetWingArea (double S)

void	SetXYZrp (int idx, double value)

Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *)
	Constructor.

	~FGModel () override
	Destructor.

virtual SGPath	FindFullPathName (const SGPath &path) const

FGFDMExec *	GetExec (void)

const std::string &	GetName (void)

unsigned int	GetRate (void)
	Get the output rate for the model in frames.

bool	InitModel (void) override

void	SetPropertyManager (std::shared_ptr< FGPropertyManager > fgpm)

void	SetRate (unsigned int tt)
	Set the ouput rate for the model in frames.

Public Member Functions inherited from FGModelFunctions
std::string	GetFunctionStrings (const std::string &delimeter) const
	Gets the strings for the current set of functions. More...

std::string	GetFunctionValues (const std::string &delimeter) const
	Gets the function values. More...

std::shared_ptr< FGFunction >	GetPreFunction (const std::string &name)
	Get one of the "pre" function. More...

bool	Load (Element el, FGFDMExec fdmex, std::string prefix="")

void	PostLoad (Element el, FGFDMExec fdmex, std::string prefix="")

void	PreLoad (Element el, FGFDMExec fdmex, std::string prefix="")

void	RunPostFunctions (void)

void	RunPreFunctions (void)

Public Member Functions inherited from FGJSBBase
	FGJSBBase ()
	Constructor for FGJSBBase.

virtual	~FGJSBBase ()
	Destructor for FGJSBBase.

void	disableHighLighting (void)
	Disables highlighting in the console output.

Public Attributes
struct JSBSim::FGAircraft::Inputs	in

Additional Inherited Members
Public Types inherited from FGJSBBase
enum	{ eL = 1 , eM , eN }
	Moments L, M, N.

enum	{ eP = 1 , eQ , eR }
	Rates P, Q, R.

enum	{ eU = 1 , eV , eW }
	Velocities U, V, W.

enum	{ eX = 1 , eY , eZ }
	Positions X, Y, Z.

enum	{ ePhi = 1 , eTht , ePsi }
	Euler angles Phi, Theta, Psi.

enum	{ eDrag = 1 , eSide , eLift }
	Stability axis forces, Drag, Side force, Lift.

enum	{ eRoll = 1 , ePitch , eYaw }
	Local frame orientation Roll, Pitch, Yaw.

enum	{ eNorth = 1 , eEast , eDown }
	Local frame position North, East, Down.

enum	{ eLat = 1 , eLong , eRad }
	Locations Radius, Latitude, Longitude.

enum	{ inNone = 0 , inDegrees , inRadians , inMeters , inFeet }
	Conversion specifiers.

Static Public Member Functions inherited from FGJSBBase
static const std::string &	GetVersion (void)
	Returns the version number of JSBSim. More...

static constexpr double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit. More...

static constexpr double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine. More...

static constexpr double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius. More...

static constexpr double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine. More...

static constexpr double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin. More...

static constexpr double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius. More...

static constexpr double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit. More...

static constexpr double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin. More...

static constexpr double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius. More...

static constexpr double	FeetToMeters (double measure)
	Converts from feet to meters. More...

static bool	EqualToRoundoff (double a, double b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison. More...

static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison. More...

static constexpr double	Constrain (double min, double value, double max)
	Constrain a value between a minimum and a maximum value.

static constexpr double	sign (double num)

Static Public Attributes inherited from FGJSBBase
static char	highint [5] = {27, '[', '1', 'm', '\0' }
	highlights text

static char	halfint [5] = {27, '[', '2', 'm', '\0' }
	low intensity text

static char	normint [6] = {27, '[', '2', '2', 'm', '\0' }
	normal intensity text

static char	reset [5] = {27, '[', '0', 'm', '\0' }
	resets text properties

static char	underon [5] = {27, '[', '4', 'm', '\0' }
	underlines text

static char	underoff [6] = {27, '[', '2', '4', 'm', '\0' }
	underline off

static char	fgblue [6] = {27, '[', '3', '4', 'm', '\0' }
	blue text

static char	fgcyan [6] = {27, '[', '3', '6', 'm', '\0' }
	cyan text

static char	fgred [6] = {27, '[', '3', '1', 'm', '\0' }
	red text

static char	fggreen [6] = {27, '[', '3', '2', 'm', '\0' }
	green text

static char	fgdef [6] = {27, '[', '3', '9', 'm', '\0' }
	default text

static short	debug_lvl = 1

Protected Member Functions inherited from FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory. More...

Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)

Protected Attributes inherited from FGModel
unsigned int	exe_ctr

FGFDMExec *	FDMExec

std::string	Name

std::shared_ptr< FGPropertyManager >	PropertyManager

unsigned int	rate

Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties

std::vector< std::shared_ptr< FGFunction > >	PostFunctions

std::vector< std::shared_ptr< FGFunction > >	PreFunctions

Static Protected Attributes inherited from FGJSBBase
static constexpr double	radtodeg = 180. / M_PI

static constexpr double	degtorad = M_PI / 180.

static constexpr double	hptoftlbssec = 550.0

static constexpr double	psftoinhg = 0.014138

static constexpr double	psftopa = 47.88

static constexpr double	fttom = 0.3048

static constexpr double	ktstofps = 1852./(3600*fttom)

static constexpr double	fpstokts = 1.0 / ktstofps

static constexpr double	inchtoft = 1.0/12.0

static constexpr double	m3toft3 = 1.0/(fttomfttomfttom)

static constexpr double	in3tom3 = inchtoftinchtoftinchtoft/m3toft3

static constexpr double	inhgtopa = 3386.38

static constexpr double	slugtolb = 32.174049
	Note that definition of lbtoslug by the inverse of slugtolb and not to a different constant you can also get from some tables will make lbtoslug*slugtolb == 1 up to the magnitude of roundoff. More...

static constexpr double	lbtoslug = 1.0/slugtolb

static constexpr double	kgtolb = 2.20462

static constexpr double	kgtoslug = 0.06852168

static const std::string	needed_cfg_version = "2.0"

static const std::string	JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__

Constructor & Destructor Documentation

◆ FGAircraft()

FGAircraft ( FGFDMExec * Executive )

Constructor.

Parameters

Executive a pointer to the parent executive object

Definition at line 52 of file FGAircraft.cpp.

                                        : FGModel(fdmex)
 {
   Name = "FGAircraft";
   WingSpan = 0.0;
   WingArea = 0.0;
   cbar = 0.0;
   HTailArea = VTailArea = 0.0;
   HTailArm  = VTailArm  = 0.0;
   lbarh = lbarv = 0.0;
   vbarh = vbarv = 0.0;
   WingIncidence = 0.0;
  
   bind();
  
   Debug(0);
 }

Member Function Documentation

◆ GetAircraftName()

const std::string& GetAircraftName ( void ) const

inline

Gets the aircraft name.

Returns: the name of the aircraft as a string type

Definition at line 131 of file FGAircraft.h.

131 { return AircraftName; }

Here is the caller graph for this function:

◆ GetXYZrp()

const FGColumnVector3& GetXYZrp ( void ) const

inline

Gets the the aero reference point (RP) coordinates.

Returns: a vector containing the RP coordinates in the structural frame.

Definition at line 155 of file FGAircraft.h.

155 { return vXYZrp; }

◆ Load()

bool Load ( Element * el )

overridevirtual

Loads the aircraft.

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 116 of file FGAircraft.cpp.

 {
   string element_name;
   Element* element;
  
   if (!FGModel::Upload(el, true)) return false;
  
   if (el->FindElement("wingarea"))
     WingArea = el->FindElementValueAsNumberConvertTo("wingarea", "FT2");
   if (el->FindElement("wingspan"))
     WingSpan = el->FindElementValueAsNumberConvertTo("wingspan", "FT");
   if (el->FindElement("chord"))
     cbar = el->FindElementValueAsNumberConvertTo("chord", "FT");
   if (el->FindElement("wing_incidence"))
     WingIncidence = el->FindElementValueAsNumberConvertTo("wing_incidence", "RAD");
   if (el->FindElement("htailarea"))
     HTailArea = el->FindElementValueAsNumberConvertTo("htailarea", "FT2");
   if (el->FindElement("htailarm"))
     HTailArm = el->FindElementValueAsNumberConvertTo("htailarm", "FT");
   if (el->FindElement("vtailarea"))
     VTailArea = el->FindElementValueAsNumberConvertTo("vtailarea", "FT2");
   if (el->FindElement("vtailarm"))
     VTailArm = el->FindElementValueAsNumberConvertTo("vtailarm", "FT");
  
   // Find all LOCATION elements that descend from this METRICS branch of the
   // config file. This would be CG location, eyepoint, etc.
  
   element = el->FindElement("location");
   while (element) {
     element_name = element->GetAttributeValue("name");
  
     if (element_name == "AERORP") vXYZrp = element->FindElementTripletConvertTo("IN");
     else if (element_name == "EYEPOINT") vXYZep = element->FindElementTripletConvertTo("IN");
     else if (element_name == "VRP") vXYZvrp = element->FindElementTripletConvertTo("IN");
  
     element = el->FindNextElement("location");
   }
  
   // calculate some derived parameters
   if (cbar != 0.0) {
     lbarh = HTailArm/cbar;
     lbarv = VTailArm/cbar;
     if (WingArea != 0.0) {
       vbarh = HTailArm*HTailArea / (cbar*WingArea);
       vbarv = VTailArm*VTailArea / (WingSpan*WingArea);
     }
   }
  
   PostLoad(el, FDMExec);
  
   Debug(2);
  
   return true;
 }

Here is the call graph for this function:

◆ Run()

bool Run ( bool Holding )

overridevirtual

Runs the Aircraft model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold.

Parameters

Holding if true, the executive has been directed to hold the sim from advancing time. Some models may ignore this flag, such as the Input model, which may need to be active to listen on a socket for the "Resume" command to be given.

See also: JSBSim.cpp documentation

Returns: false if no error

Reimplemented from FGModel.

Definition at line 90 of file FGAircraft.cpp.

 {
   if (FGModel::Run(Holding)) return true;
   if (Holding) return false;
  
   RunPreFunctions();
  
   vForces = in.AeroForce;
   vForces += in.PropForce;
   vForces += in.GroundForce;
   vForces += in.ExternalForce;
   vForces += in.BuoyantForce;
  
   vMoments = in.AeroMoment;
   vMoments += in.PropMoment;
   vMoments += in.GroundMoment;
   vMoments += in.ExternalMoment;
   vMoments += in.BuoyantMoment;
  
   RunPostFunctions();
  
   return false;
 }

Here is the call graph for this function:

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

Detailed Description

Configuration File Format for <metrics> Section:

Classes

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FGAircraft()

Member Function Documentation

◆ GetAircraftName()

◆ GetXYZrp()

◆ Load()

◆ Run()