Detailed Description

template<typename func_t>
class JSBSim::aFunc< func_t, 0 >

Definition at line 108 of file FGFunction.cpp.

Inheritance diagram for aFunc< func_t, 0 >:

Collaboration diagram for aFunc< func_t, 0 >:

Public Member Functions
	aFunc (const func_t &_f, std::shared_ptr< FGPropertyManager > pm, Element *el, const string &Prefix)

double	GetValue (void) const override

bool	IsConstant (void) const override

Public Member Functions inherited from FGFunction
	FGFunction ()
	Default constructor.

	FGFunction (FGFDMExec fdmex, Element element, const std::string &prefix="", FGPropertyValue *var=0L)
	Constructor.

	FGFunction (std::shared_ptr< FGPropertyManager > pm)

	~FGFunction (void) override
	Destructor Make sure the function is untied before destruction.

void	cacheValue (bool shouldCache)
	Specifies whether to cache the value of the function, so it is calculated only once per frame.

std::string	GetName (void) const override
	Retrieves the name of the function.

double	GetValue (void) const override
	Retrieves the value of the function object.

std::string	GetValueAsString (void) const
	The value that the function evaluates to, as a string.

bool	IsConstant (void) const override
	Does the function always return the same result (i.e.

Public Member Functions inherited from FGParameter
double	getDoubleValue (void) const

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
void	bind (Element *el, const string &Prefix) override

Protected Member Functions inherited from FGFunction
void	CheckMaxArguments (Element *el, unsigned int _max)

void	CheckMinArguments (Element *el, unsigned int _min)

void	CheckOddOrEvenArguments (Element *el, OddEven odd_even)

std::string	CreateOutputNode (Element *el, const std::string &Prefix)

void	Load (Element element, FGPropertyValue var, FGFDMExec *fdmex, const std::string &prefix="")

Additional Inherited Members
Public Types inherited from FGFunction
enum class	OddEven { Either , Odd , Even }

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)

Protected Attributes inherited from FGFunction
bool	cached

double	cachedValue

std::vector< FGParameter_ptr >	Parameters

SGPropertyNode_ptr	pNode

std::shared_ptr< FGPropertyManager >	PropertyManager

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__

Constructor & Destructor Documentation

◆ aFunc()

template<typename func_t >

aFunc	(	const func_t &	_f,
		std::shared_ptr< FGPropertyManager >	pm,
		Element *	el,
		const string &	Prefix
	)

inline

Definition at line 111 of file FGFunction.cpp.

    : FGFunction(pm), f(_f)
  {
    if (el->GetNumElements() != 0) {
      ostringstream buffer;
      buffer << el->ReadFrom() << fgred << highint
             << "<" << el->GetName() << "> should have no arguments." << reset
             << endl;
      throw WrongNumberOfArguments(buffer.str(), Parameters, el);
    }
 
    bind(el, Prefix);
  }

Member Function Documentation

◆ bind()

template<typename func_t >

void bind	(	Element *	el,
		const string &	Prefix
	)

inlineoverrideprotectedvirtual

Reimplemented from FGFunction.

Definition at line 141 of file FGFunction.cpp.

                                                        {
    CreateOutputNode(el, Prefix);
    // Initialize the node to a sensible value.
    if (pNode) pNode->setDoubleValue(f());
  }

◆ GetValue()

template<typename func_t >

double GetValue ( void ) const

inlineoverridevirtual

Implements FGParameter.

Definition at line 126 of file FGFunction.cpp.

                                       {
    double result = cached ? cachedValue : f();
    if (pNode) pNode->setDoubleValue(result);
    return result;
  }

◆ IsConstant()

template<typename func_t >

bool IsConstant ( void ) const

inlineoverridevirtual

Reimplemented from FGParameter.

Definition at line 133 of file FGFunction.cpp.

                                       {
    return false;
  }

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

FGFunction.cpp

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ aFunc()

Member Function Documentation

◆ bind()

◆ GetValue()

◆ IsConstant()