FlightGear next
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
JSBSim::FGModelFunctions Class Reference

The model functions class provides the capability for loading, storing, and executing arbitrary functions. More...

#include <FGModelFunctions.h>

Inherits JSBSim::FGJSBBase.

Inherited by JSBSim::FGEngine, and JSBSim::FGModel.

Public Member Functions

virtual ~FGModelFunctions ()
 
void RunPreFunctions (void)
 
void RunPostFunctions (void)
 
bool Load (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PreLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PostLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
std::string GetFunctionStrings (const std::string &delimeter) const
 Gets the strings for the current set of functions.
 
std::string GetFunctionValues (const std::string &delimeter) const
 Gets the function values.
 
FGFunction * GetPreFunction (const std::string &name)
 Get one of the "pre" function.
 
- Public Member Functions inherited from JSBSim::FGJSBBase
 FGJSBBase ()
 Constructor for FGJSBBase.
 
virtual ~FGJSBBase ()
 Destructor for FGJSBBase.
 
void PutMessage (const Message &msg)
 Places a Message structure on the Message queue.
 
void PutMessage (const std::string &text)
 Creates a message with the given text and places it on the queue.
 
void PutMessage (const std::string &text, bool bVal)
 Creates a message with the given text and boolean value and places it on the queue.
 
void PutMessage (const std::string &text, int iVal)
 Creates a message with the given text and integer value and places it on the queue.
 
void PutMessage (const std::string &text, double dVal)
 Creates a message with the given text and double value and places it on the queue.
 
int SomeMessages (void) const
 Reads the message on the queue (but does not delete it).
 
void ProcessMessage (void)
 Reads the message on the queue and removes it from the queue.
 
Message * ProcessNextMessage (void)
 Reads the next message on the queue and removes it from the queue.
 
void disableHighLighting (void)
 Disables highlighting in the console output.
 

Protected Member Functions

virtual bool InitModel (void)
 

Protected Attributes

std::vector< FGFunction * > PreFunctions
 
std::vector< FGFunction * > PostFunctions
 
FGPropertyReader LocalProperties
 

Additional Inherited Members

- Public Types inherited from JSBSim::FGJSBBase
enum  { eL = 1 , eM , eN }
 Moments L, M, N. More...
 
enum  { eP = 1 , eQ , eR }
 Rates P, Q, R. More...
 
enum  { eU = 1 , eV , eW }
 Velocities U, V, W. More...
 
enum  { eX = 1 , eY , eZ }
 Positions X, Y, Z. More...
 
enum  { ePhi = 1 , eTht , ePsi }
 Euler angles Phi, Theta, Psi. More...
 
enum  { eDrag = 1 , eSide , eLift }
 Stability axis forces, Drag, Side force, Lift. More...
 
enum  { eRoll = 1 , ePitch , eYaw }
 Local frame orientation Roll, Pitch, Yaw. More...
 
enum  { eNorth = 1 , eEast , eDown }
 Local frame position North, East, Down. More...
 
enum  { eLat = 1 , eLong , eRad }
 Locations Radius, Latitude, Longitude. More...
 
enum  {
  inNone = 0 , inDegrees , inRadians , inMeters ,
  inFeet
}
 Conversion specifiers. More...
 
static const std::string & GetVersion (void)
 Returns the version number of JSBSim.
 
static constexpr double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit.
 
static constexpr double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine.
 
static constexpr double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius.
 
static constexpr double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine.
 
static constexpr double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin.
 
static constexpr double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius.
 
static constexpr double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit.
 
static constexpr double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin.
 
static constexpr double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius.
 
static constexpr double FeetToMeters (double measure)
 Converts from feet to meters.
 
static double PitotTotalPressure (double mach, double p)
 Compute the total pressure in front of the Pitot tube.
 
static double MachFromImpactPressure (double qc, double p)
 Compute the Mach number from the differential pressure (qc) and the static pressure.
 
static double VcalibratedFromMach (double mach, double p)
 Calculate the calibrated airspeed from the Mach number.
 
static double MachFromVcalibrated (double vcas, double p)
 Calculate the Mach number from the calibrated airspeed.Based on the formulas in the US Air Force Aircraft Performance Flight Testing Manual (AFFTC-TIH-99-01).
 
static bool EqualToRoundoff (double a, double b)
 Finite precision comparison.
 
static bool EqualToRoundoff (float a, float b)
 Finite precision comparison.
 
static bool EqualToRoundoff (float a, double b)
 Finite precision comparison.
 
static bool EqualToRoundoff (double a, float b)
 Finite precision comparison.
 
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 double GaussianRandomNumber (void)
 
- Static Public Attributes inherited from JSBSim::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
 
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
static Message localMsg
 
static std::queue< Message > Messages
 
static unsigned int messageId = 0
 
static constexpr double radtodeg = 180. / 3.14159265358979323846
 
static constexpr double degtorad = 3.14159265358979323846 / 180.
 
static constexpr double hptoftlbssec = 550.0
 
static constexpr double psftoinhg = 0.014138
 
static constexpr double psftopa = 47.88
 
static constexpr double ktstofps = 1.68781
 
static constexpr double fpstokts = 1.0 / ktstofps
 
static constexpr double inchtoft = 1.0/12.0
 
static constexpr double fttom = 0.3048
 
static constexpr double m3toft3 = 1.0/(fttom*fttom*fttom)
 
static constexpr double in3tom3 = inchtoft*inchtoft*inchtoft/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.
 
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__
 
static int gaussian_random_number_phase = 0
 

Detailed Description

The model functions class provides the capability for loading, storing, and executing arbitrary functions.

For certain classes, such as the engine, aerodynamics, ground reactions, mass balance, etc., it can be useful to incorporate special functions that can operate on the local model parameters before and/or after the model executes. For example, there is no inherent chamber pressure calculation done in the rocket engine model. However, an arbitrary function can be added to a specific rocket engine XML configuration file. It would be tagged with a "pre" or "post" type attribute to denote whether the function is to be executed before or after the standard model algorithm.

Author
Jon Berndt

Definition at line 72 of file FGModelFunctions.h.

Constructor & Destructor Documentation

◆ ~FGModelFunctions()

JSBSim::FGModelFunctions::~FGModelFunctions ( )
virtual

Definition at line 52 of file FGModelFunctions.cpp.

Member Function Documentation

◆ GetFunctionStrings()

string JSBSim::FGModelFunctions::GetFunctionStrings ( const std::string & delimeter) const

Gets the strings for the current set of functions.

Parameters
delimetereither a tab or comma string depending on output type
Returns
a string containing the descriptive names for all functions

Definition at line 153 of file FGModelFunctions.cpp.

◆ GetFunctionValues()

string JSBSim::FGModelFunctions::GetFunctionValues ( const std::string & delimeter) const

Gets the function values.

Parameters
delimetereither a tab or comma string depending on output type
Returns
a string containing the numeric values for the current set of functions

Definition at line 176 of file FGModelFunctions.cpp.

◆ GetPreFunction()

FGFunction * JSBSim::FGModelFunctions::GetPreFunction ( const std::string & name)

Get one of the "pre" function.

Parameters
namethe name of the requested function.
Returns
a pointer to the function (NULL if not found)

Definition at line 141 of file FGModelFunctions.cpp.

◆ InitModel()

bool JSBSim::FGModelFunctions::InitModel ( void )
protectedvirtual

Reimplemented in JSBSim::FGAccelerations, JSBSim::FGAerodynamics, JSBSim::FGAircraft, JSBSim::FGAtmosphere, JSBSim::FGAuxiliary, JSBSim::FGBuoyantForces, JSBSim::FGExternalReactions, JSBSim::FGFCS, JSBSim::FGGroundReactions, JSBSim::FGInput, JSBSim::FGInputSocket, JSBSim::FGInputType, JSBSim::FGMassBalance, JSBSim::FGModel, JSBSim::FGOutput, JSBSim::FGOutputFile, JSBSim::FGOutputSocket, JSBSim::FGOutputType, JSBSim::FGPropagate, JSBSim::FGPropulsion, JSBSim::FGStandardAtmosphere, and JSBSim::FGWinds.

Definition at line 62 of file FGModelFunctions.cpp.

◆ Load()

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

Definition at line 71 of file FGModelFunctions.cpp.

◆ PostLoad()

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

Definition at line 102 of file FGModelFunctions.cpp.

◆ PreLoad()

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

Definition at line 81 of file FGModelFunctions.cpp.

◆ RunPostFunctions()

void JSBSim::FGModelFunctions::RunPostFunctions ( void )

Definition at line 133 of file FGModelFunctions.cpp.

◆ RunPreFunctions()

void JSBSim::FGModelFunctions::RunPreFunctions ( void )

Definition at line 121 of file FGModelFunctions.cpp.

Member Data Documentation

◆ LocalProperties

FGPropertyReader JSBSim::FGModelFunctions::LocalProperties
protected

Definition at line 102 of file FGModelFunctions.h.

◆ PostFunctions

std::vector<FGFunction*> JSBSim::FGModelFunctions::PostFunctions
protected

Definition at line 101 of file FGModelFunctions.h.

◆ PreFunctions

std::vector<FGFunction*> JSBSim::FGModelFunctions::PreFunctions
protected

Definition at line 100 of file FGModelFunctions.h.

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