JSBSim Namespace Reference


Classes

struct  ap_array
class  Element
 Encapsulates an XML element. More...
class  FGActuator
 Encapsulates an Actuator component for the flight control system. More...
class  FGAerodynamics
 Encapsulates the aerodynamic calculations. More...
class  FGAircraft
 Encapsulates an Aircraft and its systems. More...
class  FGAtmosphere
 Models the 1976 Standard Atmosphere. More...
class  FGAuxiliary
 Encapsulates various uncategorized scheduled functions. More...
class  FGBallonet
 Models a ballonet inside a gas cell. More...
class  FGBuoyantForces
 Encapsulates the Buoyant forces calculations. More...
class  FGColumnVector3
 This class implements a 3 element column vector. More...
class  FGCondition
 Encapsulates a condition, which is used in parts of JSBSim including switches. More...
class  FGDeadBand
 Models a deadband object. More...
class  FGElectric
 Models an electric motor. More...
class  FGEngine
 Base class for all engines. More...
class  FGExternalForce
 Encapsulates code that models an individual arbitrary force. More...
class  FGExternalReactions
 Manages the external and/or arbitrary forces. More...
class  FGFCS
 Encapsulates the Flight Control System (FCS) functionality. More...
class  FGFCSComponent
 Base class for JSBSim Flight Control System Components. More...
class  FGFCSFunction
 Models a FCSFunction object. More...
class  FGFDMExec
 Encapsulates the JSBSim simulation executive. More...
class  FGfdmSocket
class  FGFilter
 Encapsulates a filter for the flight control system. More...
class  FGForce
 Utility class that aids in the conversion of forces between coordinate systems and calculation of moments. More...
class  FGFunction
 Represents a mathematical function. More...
class  FGGain
 Encapsulates a gain component for the flight control system. More...
class  FGGasCell
 Models a gas cell. More...
class  FGGradient
 Encapsulates a gradient component for the flight control system. More...
class  FGGroundCallback
 This class provides callback slots to get ground specific data like ground elevation and such. More...
class  FGGroundReactions
 Manages ground reactions modeling. More...
class  FGInertial
 Models inertial forces (e.g. More...
class  FGInitialCondition
 Initializes the simulation run. More...
class  FGInput
 Handles simulation socket input. More...
class  FGJSBBase
 JSBSim Base class. More...
class  FGKinemat
 Encapsulates a kinematic (mechanical) component for the flight control system. More...
class  FGLGear
 Landing gear model. More...
class  FGLocation
 Holds an arbitrary location in the earth centered reference frame. More...
class  FGMars
 Models the Martian atmosphere. More...
class  FGMassBalance
 Models weight, balance and moment of inertia information. More...
class  FGMatrix33
 Handles matrix math operations. More...
class  FGModel
 Base class for all scheduled JSBSim models. More...
class  FGNozzle
 Models a rocket nozzle. More...
class  FGOutput
 Handles simulation output. More...
class  FGParameter
 Represents various types of parameters. More...
class  FGPID
 Encapsulates a PID control component for the flight control system. More...
class  FGPiston
 Models Dave Luff's Turbo/Supercharged Piston engine model. More...
class  FGPropagate
 Models the EOM and integration/propagation of state. More...
class  FGPropeller
 FGPropeller models a propeller given the tabular data for Ct and Cp, indexed by the advance ratio "J". More...
class  FGPropertyManager
 Class wrapper for property handling. More...
class  FGPropertyValue
 Represents a property value. More...
class  FGPropulsion
 Propulsion management class. More...
class  FGQuaternion
 Models the Quaternion representation of rotations. More...
class  FGRealValue
 Represents a real value. More...
class  FGRocket
 Models a generic rocket engine. More...
class  FGRotor
 Models a rotor (such as for a helicopter); NOT YET IMPLEMENTED. More...
class  FGScript
 Encapsulates the JSBSim scripting capability. More...
class  FGSensor
 Encapsulates a Sensor component for the flight control system. More...
class  FGState
 Encapsulates the calculation of aircraft state. More...
class  FGSummer
 Models a flight control system summing component. More...
class  FGSwitch
 Encapsulates a switch for the flight control system. More...
class  FGTable
 Lookup table class. More...
class  FGTank
 Models a fuel tank. More...
class  FGThruster
 Base class for specific thrusting devices such as propellers, nozzles, etc. More...
class  FGTrim
 The trimming routine for JSBSim. More...
class  FGTrimAnalysis
class  FGTrimAnalysisControl
 Models an aircraft control variables for purposes of trimming. More...
class  FGTrimAxis
class  FGTurbine
 This class models a turbine engine. More...
class  FGTurboProp
 Turboprop engine model. More...
class  FGXMLFileRead
class  FGXMLParse
 Encapsulates an XML parser based on the EasyXML parser from the SimGear library. More...
class  MatrixException
 Exception convenience class. More...
class  MSIS
struct  nrlmsise_flags
 Models the MSIS-00 atmosphere. More...
struct  nrlmsise_input
struct  nrlmsise_output
class  Objective

Enumerations

enum  Control {
  tThrottle, tBeta, tAlpha, tElevator,
  tAileron, tRudder, tAltAGL, tTheta,
  tPhi, tGamma, tPitchTrim, tRollTrim,
  tYawTrim, tHeading
}
enum  OutputForm {
  ofRad = 0, ofDeg, ofNorm, ofMag,
  NForms
}
enum  speedset {
  setvt, setvc, setve, setmach,
  setuvw, setned, setvg
}
enum  State {
  tAll, tUdot, tVdot, tWdot,
  tQdot, tPdot, tRdot, tHmgt,
  tNlf
}
 Models an aircraft axis for purposes of trimming.
enum  TaControl {
  taThrottle = 0, taPitchTrim, taRollTrim, taYawTrim,
  taElevator, taAileron, taRudder, taPhi,
  taTheta, taHeading, taGamma, taAltAGL,
  taBeta, taAlpha
}
 Available controls.
enum  TaState {
  taAll, taUdot, taVdot, taWdot,
  taQdot, taPdot, taRdot, taHmgt,
  taNlf
}
 Available target state.
enum  TrimAnalysisMode {
  taLongitudinal = 0, taFull, taFullWingsLevel, taTurn,
  taPullup, taTurnFull, taGround, taCustom,
  taNone
}
enum  TrimMode {
  tLongitudinal = 0, tFull, tGround, tPullup,
  tCustom, tTurn, tNone
}
enum  windset { setwned, setwmd, setwhc }

Functions

void checkTied (FGPropertyManager *node)
void find_CostFunctionFull (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
 Wrapping function for the effective Full Trim cost function, to be called by optimization method.
void find_CostFunctionFullCoordinatedTurn (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
 Wrapping function for the effective Steady Turn Trim cost function, to be called by optimization method.
void find_CostFunctionFullTurn (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
 Wrapping function for the effective Steady Turn Trim cost function, to be called by optimization method.
void find_CostFunctionFullWingsLevel (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
 Wrapping function for the effective Wings Level Trim cost function, to be called by optimization method.
void find_CostFunctionLongitudinal (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
 Wrapping function for the effective Longitudinal Trim cost function, to be called by optimization method.
void find_CostFunctionPullUp (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
 Wrapping function for the effective Pullup Trim cost function, to be called by optimization method.
FGQuaternion operator * (double scalar, const FGQuaternion &q)
 Scalar multiplication.
FGMatrix33 operator * (double scalar, const FGMatrix33 &A)
 Scalar multiplication.
FGMatrix33 operator * (double scalar, FGMatrix33 &M)
FGLocation operator * (double scalar, const FGLocation &l)
 Scalar multiplication.
FGColumnVector3 operator * (double scalar, const FGColumnVector3 &A)
 Scalar multiplication.
ostream & operator<< (ostream &os, const FGMatrix33 &M)
 Write matrix to a stream.
ostream & operator<< (ostream &os, const FGColumnVector3 &col)
 Write vector to a stream.
istream & operator>> (istream &is, FGMatrix33 &M)
 Read matrix from a stream.

Variables

const string ControlNames [14]
short debug_lvl
double pavgm [10]
double pavgm [10]
double pd [9][150]
double pd [9][150]
double pdl [2][25]
double pdl [2][25]
double pdm [8][10]
double pdm [8][10]
double pma [10][100]
double pma [10][100]
double ps [150]
double ps [150]
double pt [150]
double pt [150]
double ptl [4][100]
double ptl [4][100]
double ptm [10]
double sam [100]
double sam [100]
const string StateNames [10]

Function Documentation

void JSBSim::find_CostFunctionFull ( long  vars,
Vector< double > &  v,
double &  f,
bool &  success,
void *  t_ptr 
)

Parameters:
vars number ofcontrol varables
v reference to a vector containing controls variables
f function value
success 
t_ptr the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.
Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 106 of file FGTrimAnalysis.cpp.

Referenced by FGTrimAnalysis::DoTrim().

void JSBSim::find_CostFunctionFullCoordinatedTurn ( long  vars,
Vector< double > &  v,
double &  f,
bool &  success,
void *  t_ptr 
)

Parameters:
vars number ofcontrol varables
v reference to a vector containing controls variables
f function value
success 
t_ptr the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.
Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 163 of file FGTrimAnalysis.cpp.

Referenced by FGTrimAnalysis::DoTrim().

void JSBSim::find_CostFunctionFullTurn ( long  vars,
Vector< double > &  v,
double &  f,
bool &  success,
void *  t_ptr 
)

Parameters:
vars number ofcontrol varables
v reference to a vector containing controls variables
f function value
success 
t_ptr the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.
Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 182 of file FGTrimAnalysis.cpp.

Referenced by FGTrimAnalysis::DoTrim().

void JSBSim::find_CostFunctionFullWingsLevel ( long  vars,
Vector< double > &  v,
double &  f,
bool &  success,
void *  t_ptr 
)

Parameters:
vars number ofcontrol varables
v reference to a vector containing controls variables
f function value
success 
t_ptr the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.
Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 125 of file FGTrimAnalysis.cpp.

Referenced by FGTrimAnalysis::DoTrim().

void JSBSim::find_CostFunctionLongitudinal ( long  vars,
Vector< double > &  v,
double &  f,
bool &  success,
void *  t_ptr 
)

Parameters:
vars number ofcontrol varables
v reference to a vector containing controls variables
f function value
success 
t_ptr the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.
Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 144 of file FGTrimAnalysis.cpp.

Referenced by FGTrimAnalysis::DoTrim().

void JSBSim::find_CostFunctionPullUp ( long  vars,
Vector< double > &  v,
double &  f,
bool &  success,
void *  t_ptr 
)

Parameters:
vars number ofcontrol varables
v reference to a vector containing controls variables
f function value
success 
t_ptr the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.
Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 201 of file FGTrimAnalysis.cpp.

Referenced by FGTrimAnalysis::DoTrim().

FGQuaternion JSBSim::operator * ( double  scalar,
const FGQuaternion &  q 
) [inline]

Parameters:
scalar scalar value to multiply with.
q Vector to multiply.
Multiply the Vector with a scalar value.

Definition at line 491 of file FGQuaternion.h.

FGMatrix33 JSBSim::operator * ( double  scalar,
const FGMatrix33 &  A 
) [inline]

Parameters:
scalar scalar value to multiply with.
A Matrix to multiply.
Multiply the Matrix with a scalar value.

Definition at line 464 of file FGMatrix33.h.

FGLocation JSBSim::operator * ( double  scalar,
const FGLocation &  l 
) [inline]

Parameters:
scalar scalar value to multiply with.
l Vector to multiply.
Multiply the Vector with a scalar value.

Definition at line 523 of file FGLocation.h.

FGColumnVector3 JSBSim::operator * ( double  scalar,
const FGColumnVector3 &  A 
) [inline]

Parameters:
scalar scalar value to multiply with.
A Vector to multiply. Multiply the Vector with a scalar value.

Definition at line 310 of file FGColumnVector3.h.

ostream & operator<< ( ostream &  os,
const FGMatrix33 &  M 
)

Parameters:
os Stream to write to.
M Matrix to write.
Write the matrix to a stream.

Definition at line 64 of file FGMatrix33.cpp.

References FGMatrix33::Cols(), and FGMatrix33::Rows().

ostream & operator<< ( ostream &  os,
const FGColumnVector3 &  col 
)

Parameters:
os Stream to write to.
M Matrix to write. Write the matrix to a stream.

Definition at line 69 of file FGColumnVector3.cpp.

istream & operator>> ( istream &  is,
FGMatrix33 &  M 
)

Parameters:
os Stream to read from.
M Matrix to initialize with the values from the stream.
Read matrix from a stream.

Definition at line 79 of file FGMatrix33.cpp.

References FGMatrix33::Cols(), and FGMatrix33::Rows().

Variable Documentation

const string ControlNames[14]

Initial value:

 { "Throttle","Sideslip","Angle of Attack",
                                 "Elevator","Ailerons","Rudder",
                                 "Altitude AGL", "Pitch Angle",
                                 "Roll Angle", "Flight Path Angle", 
                                 "Pitch Trim", "Roll Trim", "Yaw Trim",
                                 "Heading"
                               }

Definition at line 64 of file FGTrimAxis.h.

Referenced by FGTrimAxis::GetControlName().

double pavgm[10]

Initial value:

 {
     2.61000E+02, 2.64000E+02, 2.29000E+02, 2.17000E+02, 2.17000E+02,
     2.23000E+02, 2.86760E+02,-2.93940E+00, 2.50000E+00, 0.00000E+00 }

Definition at line 743 of file FGMSISData.cpp.

double pdl[2][25]

Initial value:

 {
   { 1.09930E+00, 3.90631E+00, 3.07165E+00, 9.86161E-01, 1.63536E+01,
     4.63830E+00, 1.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 1.28840E+00, 3.10302E-02, 1.18339E-01 }, 
   { 1.00000E+00, 7.00000E-01, 1.15020E+00, 3.44689E+00, 1.28840E+00,
     1.00000E+00, 1.08738E+00, 1.22947E+00, 1.10016E+00, 7.34129E-01,
     1.15241E+00, 2.22784E+00, 7.95046E-01, 4.01612E+00, 4.47749E+00,
     1.23435E+02,-7.60535E-02, 1.68986E-06, 7.44294E-01, 1.03604E+00,
     1.72783E+02, 1.15020E+00, 3.44689E+00,-7.46230E-01, 9.49154E-01 }
}

Definition at line 381 of file FGMSISData.cpp.

double pdm[8][10]

Initial value:

 {
{    2.45600E+07, 6.71072E-06, 1.00000E+02, 0.00000E+00, 1.10000E+02,
     1.00000E+01, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00 },
{    8.59400E+10, 1.00000E+00, 1.05000E+02,-8.00000E+00, 1.10000E+02,
     1.00000E+01, 9.00000E+01, 2.00000E+00, 0.00000E+00, 0.00000E+00 },
{    2.81000E+11, 0.00000E+00, 1.05000E+02, 2.80000E+01, 2.89500E+01,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00 },
{    3.30000E+10, 2.68270E-01, 1.05000E+02, 1.00000E+00, 1.10000E+02,
     1.00000E+01, 1.10000E+02,-1.00000E+01, 0.00000E+00, 0.00000E+00 },
{    1.33000E+09, 1.19615E-02, 1.05000E+02, 0.00000E+00, 1.10000E+02,
     1.00000E+01, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00 },
{    1.76100E+05, 1.00000E+00, 9.50000E+01,-8.00000E+00, 1.10000E+02,
     1.00000E+01, 9.00000E+01, 2.00000E+00, 0.00000E+00, 0.00000E+00, },
{    1.00000E+07, 1.00000E+00, 1.05000E+02,-8.00000E+00, 1.10000E+02,
     1.00000E+01, 9.00000E+01, 2.00000E+00, 0.00000E+00, 0.00000E+00 },
{    1.00000E+06, 1.00000E+00, 1.05000E+02,-8.00000E+00, 5.50000E+02,
     7.60000E+01, 9.00000E+01, 2.00000E+00, 0.00000E+00, 4.00000E+03 }}

Definition at line 398 of file FGMSISData.cpp.

double sam[100]

Initial value:

 {
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00, 1.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00,
     0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00, 0.00000E+00
}

Definition at line 718 of file FGMSISData.cpp.

const string StateNames[10]

Initial value:

   { "all","udot","vdot","wdot","qdot","pdot","rdot",
                                "hmgt","nlf" 
                              }

Definition at line 61 of file FGTrimAxis.h.

Referenced by FGTrimAxis::GetStateName().

Generated on Sun May 4 15:10:26 2008 for JSBSim Flight Dynamics Model by  doxygen 1.5.1