JSBSim Flight Dynamics Model  1.0 (02 March 2017)
An Open Source Flight Dynamics and Control Software Library in C++
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FGModelFunctions Class Reference

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

#include <FGModelFunctions.h>

+ Inheritance diagram for FGModelFunctions:
+ Collaboration diagram for FGModelFunctions:

Public Member Functions

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...
 
FGFunction * GetPreFunction (const std::string &name)
 Get one of the "pre" function. More...
 
bool Load (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
 
void PostLoad (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
 
void PreLoad (Element *el, FGPropertyManager *PropertyManager, 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.
 
std::string GetVersion (void)
 Returns the version number of JSBSim. More...
 
void PutMessage (const Message &msg)
 Places a Message structure on the Message queue. More...
 
void PutMessage (const std::string &text)
 Creates a message with the given text and places it on the queue. More...
 
void PutMessage (const std::string &text, bool bVal)
 Creates a message with the given text and boolean value and places it on the queue. More...
 
void PutMessage (const std::string &text, int iVal)
 Creates a message with the given text and integer value and places it on the queue. More...
 
void PutMessage (const std::string &text, double dVal)
 Creates a message with the given text and double value and places it on the queue. More...
 
int SomeMessages (void)
 Reads the message on the queue (but does not delete it). More...
 
void ProcessMessage (void)
 Reads the message on the queue and removes it from the queue. More...
 
Message * ProcessNextMessage (void)
 Reads the next message on the queue and removes it from the queue. More...
 

Protected Member Functions

virtual bool InitModel (void)
 
- Protected Member Functions inherited from FGJSBBase
void Debug (int)
 

Protected Attributes

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

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 double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit. More...
 
static double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin. More...
 
static double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine. More...
 
static double Constrain (double min, double value, double max)
 Constrain a value between a minimum and a maximum value.
 
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 double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius. More...
 
static double FeetToMeters (double measure)
 Converts from feet to meters. More...
 
static double GaussianRandomNumber (void)
 
static double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius. More...
 
static double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit. More...
 
static double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine. More...
 
static double MachFromVcalibrated (double vcas, double p, double psl, double rhosl)
 Calculate the Mach number from the calibrated airspeed. More...
 
static double PitotTotalPressure (double mach, double p)
 Compute the total pressure in front of the Pitot tube. More...
 
static double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius. More...
 
static double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin. More...
 
static double sign (double num)
 
static double VcalibratedFromMach (double mach, double p, double psl, double rhosl)
 Calculate the calibrated airspeed from the Mach number. More...
 
- Static Public Attributes inherited from FGJSBBase
static short debug_lvl = 1
 
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 Protected Member Functions inherited from FGJSBBase
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- Static Protected Attributes inherited from FGJSBBase
static const double degtorad = 0.017453292519943295769236907684886
 
static const double fpstokts = 1.0/ktstofps
 
static const double fttom = 0.3048
 
static int gaussian_random_number_phase = 0
 
static const double hptoftlbssec = 550.0
 
static const double in3tom3 = 1.638706E-5
 
static const double inchtoft = 0.08333333
 
static const double inhgtopa = 3386.38
 
static const std::string JSBSim_version = "1.0 " __DATE__ " " __TIME__
 
static const double kgtolb = 2.20462
 
static const double kgtoslug = 0.06852168
 
static const double ktstofps = 1.68781
 
static const double lbtoslug = 1.0/slugtolb
 
static Message localMsg
 
static const double m3toft3 = 1.0/(fttom*fttom*fttom)
 
static double Mair = 28.9645
 
static unsigned int messageId = 0
 
static std::queue< Message > Messages
 
static const std::string needed_cfg_version = "2.0"
 
static const double psftoinhg = 0.014138
 
static const double psftopa = 47.88
 
static const double radtodeg = 57.295779513082320876798154814105
 
static double Reng = 1716.56
 
static double Rstar = 1545.348
 
static const double SHRatio = 1.40
 
static const double slugtolb = 32.174049
 

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 81 of file FGModelFunctions.h.

Member Function Documentation

◆ GetFunctionStrings()

string 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 164 of file FGModelFunctions.cpp.

165 {
166  string FunctionStrings = "";
167  bool firstime = true;
168  unsigned int sd;
169 
170  for (sd = 0; sd < PreFunctions.size(); sd++) {
171  if (firstime) {
172  firstime = false;
173  } else {
174  FunctionStrings += delimeter;
175  }
176  FunctionStrings += PreFunctions[sd]->GetName();
177  }
178 
179  for (sd = 0; sd < PostFunctions.size(); sd++) {
180  if (firstime) {
181  firstime = false;
182  } else {
183  FunctionStrings += delimeter;
184  }
185  FunctionStrings += PostFunctions[sd]->GetName();
186  }
187 
188  return FunctionStrings;
189 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetFunctionValues()

string 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 193 of file FGModelFunctions.cpp.

194 {
195  ostringstream buf;
196 
197  for (unsigned int sd = 0; sd < PreFunctions.size(); sd++) {
198  if (buf.tellp() > 0) buf << delimeter;
199  buf << PreFunctions[sd]->GetValue();
200  }
201 
202  for (unsigned int sd = 0; sd < PostFunctions.size(); sd++) {
203  if (buf.tellp() > 0) buf << delimeter;
204  buf << PostFunctions[sd]->GetValue();
205  }
206 
207  return buf.str();
208 }
+ Here is the caller graph for this function:

◆ GetPreFunction()

FGFunction * 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 148 of file FGModelFunctions.cpp.

149 {
150  FGFunction* result;
151  vector<FGFunction*>::iterator it = PreFunctions.begin();
152 
153  for (; it != PreFunctions.end(); ++it) {
154  result = *it;
155  if (result->GetName() == name)
156  return result;
157  }
158 
159  return 0;
160 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following files: