JSBSim Flight Dynamics Model  1.2.0 (05 Nov 2023)
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

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

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

Protected Member Functions

virtual bool InitModel (void)
 

Protected Attributes

FGPropertyReader LocalProperties
 
std::vector< std::shared_ptr< FGFunction > > PostFunctions
 
std::vector< std::shared_ptr< 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 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
 
- Static Protected Member Functions inherited from FGJSBBase
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- 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/(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. 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__
 

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

144 {
145  string FunctionStrings;
146 
147  for (auto& prefunc: PreFunctions) {
148  if (!FunctionStrings.empty())
149  FunctionStrings += delimeter;
150 
151  FunctionStrings += prefunc->GetName();
152  }
153 
154  for (auto& postfunc: PostFunctions) {
155  if (!FunctionStrings.empty())
156  FunctionStrings += delimeter;
157 
158  FunctionStrings += postfunc->GetName();
159  }
160 
161  return FunctionStrings;
162 }
+ 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 166 of file FGModelFunctions.cpp.

167 {
168  ostringstream buf;
169 
170  for (auto& prefunc: PreFunctions) {
171  if (buf.tellp() > 0) buf << delimeter;
172  buf << prefunc->GetValue();
173  }
174 
175  for (auto& postfunc: PostFunctions) {
176  if (buf.tellp() > 0) buf << delimeter;
177  buf << postfunc->GetValue();
178  }
179 
180  return buf.str();
181 }
+ Here is the caller graph for this function:

◆ GetPreFunction()

std::shared_ptr< 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 131 of file FGModelFunctions.cpp.

132 {
133  for (auto& prefunc: PreFunctions) {
134  if (prefunc->GetName() == name)
135  return prefunc;
136  }
137 
138  return nullptr;
139 }
The documentation for this class was generated from the following files: