FlightGear: JSBSim::aFunc< func_t, 0 > Class Template Reference

Inherits JSBSim::FGFunction, and JSBSim::FGFunction.

Public Member Functions
	aFunc (const func_t &_f, FGPropertyManager pm, Element el, const string &Prefix)

double	GetValue (void) const override

bool	IsConstant (void) const override

	aFunc (const func_t &_f, FGFDMExec fdmex, Element el, const string &prefix, FGPropertyValue *v, unsigned int Nmax=Nmin, FGFunction::OddEven odd_even=FGFunction::OddEven::Either)

double	GetValue (void) const override

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

	FGFunction (FGPropertyManager *pm)

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

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

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.

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

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

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

Public Member Functions inherited from JSBSim::FGParameter
virtual	~FGParameter (void)

double	getDoubleValue (void) const

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

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

Protected Member Functions inherited from JSBSim::FGFunction
void	Load (Element element, FGPropertyValue var, FGFDMExec *fdmex, const std::string &prefix="")

virtual void	bind (Element *, const std::string &)

void	CheckMinArguments (Element *el, unsigned int _min)

void	CheckMaxArguments (Element *el, unsigned int _max)

void	CheckOddOrEvenArguments (Element *el, OddEven odd_even)

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

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

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)

Protected Attributes inherited from JSBSim::FGFunction
bool	cached

double	cachedValue

std::vector< FGParameter_ptr >	Parameters

FGPropertyManager *	PropertyManager

FGPropertyNode_ptr	pNode

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/(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__

static int	gaussian_random_number_phase = 0

Detailed Description

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

Definition at line 109 of file FGFunction.cpp.

Constructor & Destructor Documentation

◆ aFunc() [1/2]

template<typename func_t>

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

inline

Definition at line 112 of file FGFunction.cpp.

◆ aFunc() [2/2]

JSBSim::aFunc< func_t, Nmin >::aFunc	(	const func_t &	_f,
		FGFDMExec *	fdmex,
		Element *	el,
		const string &	prefix,
		FGPropertyValue *	v,
		unsigned int	Nmax = Nmin,
		FGFunction::OddEven	odd_even = FGFunction::OddEven::Either )

inline

Definition at line 79 of file FGFunction.cpp.

Member Function Documentation

◆ bind() [1/2]

void JSBSim::aFunc< func_t, Nmin >::bind	(	Element *	el,
		const string &	Prefix )

inlineoverrideprotected

Definition at line 95 of file FGFunction.cpp.

◆ bind() [2/2]

template<typename func_t>

void JSBSim::aFunc< func_t, 0 >::bind	(	Element *	el,
		const string &	Prefix )

inlineoverrideprotected

Definition at line 142 of file FGFunction.cpp.

◆ GetValue() [1/2]

double JSBSim::aFunc< func_t, Nmin >::GetValue ( void ) const

inlineoverridevirtual

Implements JSBSim::FGParameter.

Definition at line 90 of file FGFunction.cpp.

◆ GetValue() [2/2]

template<typename func_t>

double JSBSim::aFunc< func_t, 0 >::GetValue ( void ) const

inlineoverridevirtual

Implements JSBSim::FGParameter.

Definition at line 127 of file FGFunction.cpp.

◆ IsConstant()

template<typename func_t>

bool JSBSim::aFunc< func_t, 0 >::IsConstant ( void ) const

inlineoverridevirtual

Reimplemented from JSBSim::FGParameter.

Definition at line 134 of file FGFunction.cpp.

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

FGFunction.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ aFunc() [1/2]

◆ aFunc() [2/2]

Member Function Documentation

◆ bind() [1/2]

◆ bind() [2/2]

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ IsConstant()