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.

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

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

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. 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 Public Member Functions inherited from FGJSBBase
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 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 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/(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.

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

delimeter either 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.

{
  string FunctionStrings;
 
  for (auto& prefunc: PreFunctions) {
    if (!FunctionStrings.empty())
      FunctionStrings += delimeter;
 
    FunctionStrings += prefunc->GetName();
  }
 
  for (auto& postfunc: PostFunctions) {
    if (!FunctionStrings.empty())
      FunctionStrings += delimeter;
 
    FunctionStrings += postfunc->GetName();
  }
 
  return FunctionStrings;
}

Here is the caller graph for this function:

◆ GetFunctionValues()

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

Gets the function values.

Parameters

delimeter either 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.

{
  ostringstream buf;
 
  for (auto& prefunc: PreFunctions) {
    if (buf.tellp() > 0) buf << delimeter;
    buf << prefunc->GetValue();
  }
 
  for (auto& postfunc: PostFunctions) {
    if (buf.tellp() > 0) buf << delimeter;
    buf << postfunc->GetValue();
  }
 
  return buf.str();
}

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

name	the name of the requested function.

Returns: a pointer to the function (NULL if not found)

Definition at line 131 of file FGModelFunctions.cpp.

{
  for (auto& prefunc: PreFunctions) {
    if (prefunc->GetName() == name)
      return prefunc;
  }
 
  return nullptr;
}

◆ InitModel()

bool InitModel ( void )

protectedvirtual

Reimplemented in FGPropagate, FGInputSocket, FGInputType, FGOutputFile, FGOutputSocket, FGOutputType, FGMSIS, FGAccelerations, FGInput, and FGOutput.

Definition at line 52 of file FGModelFunctions.cpp.

{
  LocalProperties.ResetToIC();
 
  return true;
}

◆ Load()

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

Definition at line 61 of file FGModelFunctions.cpp.

{
  LocalProperties.Load(el, fdmex->GetPropertyManager().get(), false);
  PreLoad(el, fdmex, prefix);
 
  return true; // TODO: Need to make this value mean something.
}

◆ PostLoad()

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

Definition at line 92 of file FGModelFunctions.cpp.

{
  // Load model post-functions, if any
 
  Element *function = el->FindElement("function");
  while (function) {
    if (function->GetAttributeValue("type") == "post") {
      PostFunctions.push_back(std::make_shared<FGFunction>(fdmex, function, prefix));
    }
    function = el->FindNextElement("function");
  }
}

◆ PreLoad()

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

Definition at line 71 of file FGModelFunctions.cpp.

{
  // Load model post-functions, if any
 
  Element *function = el->FindElement("function");
 
  while (function) {
    string fType = function->GetAttributeValue("type");
    if (fType.empty() || fType == "pre")
      PreFunctions.push_back(std::make_shared<FGFunction>(fdmex, function, prefix));
    else if (fType == "template") {
      string name = function->GetAttributeValue("name");
      fdmex->AddTemplateFunc(name, function);
    }
 
    function = el->FindNextElement("function");
  }
}

◆ RunPostFunctions()

void RunPostFunctions ( void )

Definition at line 123 of file FGModelFunctions.cpp.

{
  for (auto& postfunc: PostFunctions)
    postfunc->cacheValue(true);
}

◆ RunPreFunctions()

void RunPreFunctions ( void )

Definition at line 111 of file FGModelFunctions.cpp.

{
  for (auto& prefunc: PreFunctions)
    prefunc->cacheValue(true);
}

Member Data Documentation

◆ LocalProperties

FGPropertyReader LocalProperties

protected

Definition at line 103 of file FGModelFunctions.h.

◆ PostFunctions

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

protected

Definition at line 102 of file FGModelFunctions.h.

◆ PreFunctions

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

protected

Definition at line 101 of file FGModelFunctions.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GetFunctionStrings()

◆ GetFunctionValues()

◆ GetPreFunction()

◆ InitModel()

◆ Load()

◆ PostLoad()

◆ PreLoad()

◆ RunPostFunctions()

◆ RunPreFunctions()

Member Data Documentation

◆ LocalProperties

◆ PostFunctions

◆ PreFunctions