FlightGear: JSBSim::FGJSBBase Class Reference

#include <FGJSBBase.h>

Inherited by JSBSim::FGBallonet, JSBSim::FGCondition, JSBSim::FGFCSComponent, JSBSim::FGFDMExec, JSBSim::FGForce, JSBSim::FGFunction, JSBSim::FGInitialCondition, JSBSim::FGLocation, JSBSim::FGModelFunctions, JSBSim::FGQuaternion, JSBSim::FGScript, JSBSim::FGSensorOrientation, JSBSim::FGTable, JSBSim::FGTank, JSBSim::FGTransmission, JSBSim::FGTrim, JSBSim::FGTrimAxis, and JSBSim::FGfdmSocket.

Classes
class	Filter
	First order, (low pass / lag) filter. More...

struct	Message
	JSBSim Message structure. More...

Public Member Functions
	FGJSBBase ()
	Constructor for FGJSBBase.

virtual	~FGJSBBase ()
	Destructor for FGJSBBase.

Static Public Attributes
JSBSim console output highlighting terms.
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

JSBSim Messaging functions
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 short	debug_lvl = 1

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

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.

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 std::string	CreateIndexedPropertyName (const std::string &Property, int index)

Detailed Description

JSBSim Base class.

This class provides universal constants, utility functions, messaging functions, and enumerated constants to JSBSim.

Author: Jon S. Berndt

Definition at line 78 of file FGJSBBase.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Conversion specifiers.

Enumerator
inNone
inDegrees
inRadians
inMeters
inFeet

Definition at line 397 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Moments L, M, N.

Enumerator
eL
eM
eN

Definition at line 379 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Local frame orientation Roll, Pitch, Yaw.

Enumerator
eRoll
ePitch
eYaw

Definition at line 391 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Euler angles Phi, Theta, Psi.

Enumerator
ePhi
eTht
ePsi

Definition at line 387 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Local frame position North, East, Down.

Enumerator
eNorth
eEast
eDown

Definition at line 393 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Stability axis forces, Drag, Side force, Lift.

Enumerator
eDrag
eSide
eLift

Definition at line 389 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Locations Radius, Latitude, Longitude.

Enumerator
eLat
eLong
eRad

Definition at line 395 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Velocities U, V, W.

Enumerator
eU
eV
eW

Definition at line 383 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Positions X, Y, Z.

Enumerator
eX
eY
eZ

Definition at line 385 of file FGJSBBase.h.

◆ anonymous enum

anonymous enum

Rates P, Q, R.

Enumerator
eP
eQ
eR

Definition at line 381 of file FGJSBBase.h.

Constructor & Destructor Documentation

◆ FGJSBBase()

JSBSim::FGJSBBase::FGJSBBase ( )

inline

Constructor for FGJSBBase.

Definition at line 81 of file FGJSBBase.h.

◆ ~FGJSBBase()

virtual JSBSim::FGJSBBase::~FGJSBBase ( )

inlinevirtual

Destructor for FGJSBBase.

Definition at line 84 of file FGJSBBase.h.

Member Function Documentation

◆ CelsiusToFahrenheit()

static constexpr double JSBSim::FGJSBBase::CelsiusToFahrenheit ( double celsius )

inlinestaticconstexpr

Converts from degrees Celsius to degrees Fahrenheit.

Parameters

celsius The temperature in degrees Celsius.

Returns: The temperature in Fahrenheit.

Definition at line 237 of file FGJSBBase.h.

◆ CelsiusToKelvin()

static constexpr double JSBSim::FGJSBBase::CelsiusToKelvin ( double celsius )

inlinestaticconstexpr

Converts from degrees Celsius to degrees Kelvin.

Parameters

celsius The temperature in degrees Celsius.

Returns: The temperature in Kelvin.

Definition at line 244 of file FGJSBBase.h.

◆ CelsiusToRankine()

static constexpr double JSBSim::FGJSBBase::CelsiusToRankine ( double celsius )

inlinestaticconstexpr

Converts from degrees Celsius to degrees Rankine.

Parameters

celsius The temperature in degrees Celsius.

Returns: The temperature in Rankine.

Definition at line 202 of file FGJSBBase.h.

◆ Constrain()

static constexpr double JSBSim::FGJSBBase::Constrain	(	double	min,
		double	value,
		double	max )

inlinestaticconstexpr

Constrain a value between a minimum and a maximum value.

Definition at line 333 of file FGJSBBase.h.

◆ CreateIndexedPropertyName()

string JSBSim::FGJSBBase::CreateIndexedPropertyName	(	const std::string &	Property,
		int	index )

staticprotected

Definition at line 208 of file FGJSBBase.cpp.

◆ disableHighLighting()

void JSBSim::FGJSBBase::disableHighLighting ( void )

Disables highlighting in the console output.

Definition at line 191 of file FGJSBBase.cpp.

◆ EqualToRoundoff() [1/4]

static bool JSBSim::FGJSBBase::EqualToRoundoff	(	double	a,
		double	b )

inlinestatic

Finite precision comparison.

Parameters

a	first value to compare
b	second value to compare

Returns: if the two values can be considered equal up to roundoff

Definition at line 301 of file FGJSBBase.h.

◆ EqualToRoundoff() [2/4]

static bool JSBSim::FGJSBBase::EqualToRoundoff	(	double	a,
		float	b )

inlinestatic

Finite precision comparison.

Parameters

a	first value to compare
b	second value to compare

Returns: if the two values can be considered equal up to roundoff

Definition at line 327 of file FGJSBBase.h.

◆ EqualToRoundoff() [3/4]

static bool JSBSim::FGJSBBase::EqualToRoundoff	(	float	a,
		double	b )

inlinestatic

Finite precision comparison.

Parameters

a	first value to compare
b	second value to compare

Returns: if the two values can be considered equal up to roundoff

Definition at line 319 of file FGJSBBase.h.

◆ EqualToRoundoff() [4/4]

static bool JSBSim::FGJSBBase::EqualToRoundoff	(	float	a,
		float	b )

inlinestatic

Finite precision comparison.

Parameters

a	first value to compare
b	second value to compare

Returns: if the two values can be considered equal up to roundoff

Definition at line 310 of file FGJSBBase.h.

◆ FahrenheitToCelsius()

static constexpr double JSBSim::FGJSBBase::FahrenheitToCelsius ( double fahrenheit )

inlinestaticconstexpr

Converts from degrees Fahrenheit to degrees Celsius.

Parameters

fahrenheit The temperature in degrees Fahrenheit.

Returns: The temperature in Celsius.

Definition at line 230 of file FGJSBBase.h.

◆ FeetToMeters()

static constexpr double JSBSim::FGJSBBase::FeetToMeters ( double measure )

inlinestaticconstexpr

Converts from feet to meters.

Parameters

measure The length in feet.

Returns: The length in meters.

Definition at line 258 of file FGJSBBase.h.

◆ GaussianRandomNumber()

double JSBSim::FGJSBBase::GaussianRandomNumber ( void )

static

Definition at line 217 of file FGJSBBase.cpp.

◆ GetVersion()

static const std::string & JSBSim::FGJSBBase::GetVersion ( void )

inlinestatic

Returns the version number of JSBSim.

Returns: The version number of JSBSim.

Definition at line 185 of file FGJSBBase.h.

◆ KelvinToCelsius()

static constexpr double JSBSim::FGJSBBase::KelvinToCelsius ( double kelvin )

inlinestaticconstexpr

Converts from degrees Kelvin to degrees Celsius.

Parameters

celsius The temperature in degrees Kelvin.

Returns: The temperature in Celsius.

Definition at line 251 of file FGJSBBase.h.

◆ KelvinToFahrenheit()

static constexpr double JSBSim::FGJSBBase::KelvinToFahrenheit ( double kelvin )

inlinestaticconstexpr

Converts from degrees Kelvin to degrees Fahrenheit.

Parameters

kelvin The temperature in degrees Kelvin.

Returns: The temperature in Fahrenheit.

Definition at line 195 of file FGJSBBase.h.

◆ KelvinToRankine()

static constexpr double JSBSim::FGJSBBase::KelvinToRankine ( double kelvin )

inlinestaticconstexpr

Converts from degrees Kelvin to degrees Rankine.

Parameters

kelvin The temperature in degrees Kelvin.

Returns: The temperature in Rankine.

Definition at line 216 of file FGJSBBase.h.

◆ MachFromImpactPressure()

double JSBSim::FGJSBBase::MachFromImpactPressure	(	double	qc,
		double	p )

static

Compute the Mach number from the differential pressure (qc) and the static pressure.

Based on the formulas in the US Air Force Aircraft Performance Flight Testing Manual (AFFTC-TIH-99-01).

Parameters

qc	The differential/impact pressure
p	Pressure in psf

Returns: The Mach number

Definition at line 275 of file FGJSBBase.cpp.

◆ MachFromVcalibrated()

double JSBSim::FGJSBBase::MachFromVcalibrated	(	double	vcas,
		double	p )

static

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

Parameters

vcas	The calibrated airspeed (CAS) in ft/s
p	Pressure in psf

Returns: The Mach number

Definition at line 300 of file FGJSBBase.cpp.

◆ PitotTotalPressure()

double JSBSim::FGJSBBase::PitotTotalPressure	(	double	mach,
		double	p )

static

Compute the total pressure in front of the Pitot tube.

It uses the Rayleigh formula for supersonic speeds (See "Introduction to Aerodynamics of a Compressible Fluid - H.W. Liepmann, A.E. Puckett - Wiley & sons (1947)" §5.4 pp 75-80)

Parameters

mach	The Mach number
p	Pressure in psf

Returns: The total pressure in front of the Pitot tube in psf

Definition at line 245 of file FGJSBBase.cpp.

◆ ProcessMessage()

void JSBSim::FGJSBBase::ProcessMessage ( void )

Reads the message on the queue and removes it from the queue.

This function also prints out the message.

Definition at line 148 of file FGJSBBase.cpp.

◆ ProcessNextMessage()

FGJSBBase::Message * JSBSim::FGJSBBase::ProcessNextMessage ( void )

Reads the next message on the queue and removes it from the queue.

This function also prints out the message.

Returns: a pointer to the message, or NULL if there are no messages.

Definition at line 180 of file FGJSBBase.cpp.

◆ PutMessage() [1/5]

void JSBSim::FGJSBBase::PutMessage ( const Message & msg )

Places a Message structure on the Message queue.

Parameters

msg	pointer to a Message structure

Returns: pointer to a Message structure

Definition at line 90 of file FGJSBBase.cpp.

◆ PutMessage() [2/5]

void JSBSim::FGJSBBase::PutMessage ( const std::string & text )

Creates a message with the given text and places it on the queue.

Parameters

text	message text

Returns: pointer to a Message structure

◆ PutMessage() [3/5]

void JSBSim::FGJSBBase::PutMessage	(	const std::string &	text,
		bool	bVal )

Creates a message with the given text and boolean value and places it on the queue.

Parameters

text	message text
bVal	boolean value associated with the message

Returns: pointer to a Message structure

◆ PutMessage() [4/5]

void JSBSim::FGJSBBase::PutMessage	(	const std::string &	text,
		double	dVal )

Creates a message with the given text and double value and places it on the queue.

Parameters

text	message text
dVal	double value associated with the message

Returns: pointer to a Message structure

◆ PutMessage() [5/5]

void JSBSim::FGJSBBase::PutMessage	(	const std::string &	text,
		int	iVal )

Creates a message with the given text and integer value and places it on the queue.

Parameters

text	message text
iVal	integer value associated with the message

Returns: pointer to a Message structure

◆ RankineToCelsius()

static constexpr double JSBSim::FGJSBBase::RankineToCelsius ( double rankine )

inlinestaticconstexpr

Converts from degrees Rankine to degrees Celsius.

Parameters

rankine The temperature in degrees Rankine.

Returns: The temperature in Celsius.

Definition at line 209 of file FGJSBBase.h.

◆ RankineToKelvin()

static constexpr double JSBSim::FGJSBBase::RankineToKelvin ( double rankine )

inlinestaticconstexpr

Converts from degrees Rankine to degrees Kelvin.

Parameters

rankine The temperature in degrees Rankine.

Returns: The temperature in Kelvin.

Definition at line 223 of file FGJSBBase.h.

◆ sign()

static constexpr double JSBSim::FGJSBBase::sign ( double num )

inlinestaticconstexpr

Definition at line 337 of file FGJSBBase.h.

◆ SomeMessages()

int JSBSim::FGJSBBase::SomeMessages ( void ) const

inline

Reads the message on the queue (but does not delete it).

Returns: 1 if some messages

Definition at line 173 of file FGJSBBase.h.

◆ VcalibratedFromMach()

double JSBSim::FGJSBBase::VcalibratedFromMach	(	double	mach,
		double	p )

static

Calculate the calibrated airspeed from the Mach number.

Based on the formulas in the US Air Force Aircraft Performance Flight Testing Manual (AFFTC-TIH-99-01).

Parameters

mach	The Mach number
p	Pressure in psf

Returns: The calibrated airspeed (CAS) in ft/s

Definition at line 289 of file FGJSBBase.cpp.

Member Data Documentation

◆ debug_lvl

short JSBSim::FGJSBBase::debug_lvl = 1

static

Definition at line 190 of file FGJSBBase.h.

double JSBSim::FGJSBBase::fpstokts = 1.0 / ktstofps

staticconstexprprotected

Definition at line 354 of file FGJSBBase.h.

◆ fttom

double JSBSim::FGJSBBase::fttom = 0.3048

staticconstexprprotected

Definition at line 356 of file FGJSBBase.h.

◆ gaussian_random_number_phase

int JSBSim::FGJSBBase::gaussian_random_number_phase = 0

staticprotected

Definition at line 375 of file FGJSBBase.h.

◆ halfint

char JSBSim::FGJSBBase::halfint = {27, '[', '2', 'm', '\0' }

static

low intensity text

Definition at line 125 of file FGJSBBase.h.

◆ highint

◆ normint

char JSBSim::FGJSBBase::normint = {27, '[', '2', '2', 'm', '\0' }

static

normal intensity text

Definition at line 127 of file FGJSBBase.h.

◆ psftoinhg

double JSBSim::FGJSBBase::psftoinhg = 0.014138

staticconstexprprotected

Definition at line 351 of file FGJSBBase.h.

◆ psftopa

double JSBSim::FGJSBBase::psftopa = 47.88

staticconstexprprotected

Definition at line 352 of file FGJSBBase.h.

◆ radtodeg

double JSBSim::FGJSBBase::radtodeg = 180. / 3.14159265358979323846

staticconstexprprotected

Definition at line 348 of file FGJSBBase.h.

◆ reset

char JSBSim::FGJSBBase::reset = {27, '[', '0', 'm', '\0' }

static

resets text properties

Definition at line 129 of file FGJSBBase.h.

◆ slugtolb

double JSBSim::FGJSBBase::slugtolb = 32.174049

staticconstexprprotected

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.

So converting from slug to lb and back will yield to the original value you started with up to the magnitude of roundoff. Taken from units gnu commandline tool

Definition at line 366 of file FGJSBBase.h.

◆ underoff

char JSBSim::FGJSBBase::underoff = {27, '[', '2', '4', 'm', '\0' }

static

underline off

Definition at line 133 of file FGJSBBase.h.

◆ underon

char JSBSim::FGJSBBase::underon = {27, '[', '4', 'm', '\0' }

static

underlines text

Definition at line 131 of file FGJSBBase.h.

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

Classes

Public Member Functions

Static Public Attributes

JSBSim Messaging functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ FGJSBBase()

◆ ~FGJSBBase()

Member Function Documentation

◆ CelsiusToFahrenheit()

◆ CelsiusToKelvin()

◆ CelsiusToRankine()

◆ Constrain()

◆ CreateIndexedPropertyName()

◆ disableHighLighting()

◆ EqualToRoundoff() [1/4]

◆ EqualToRoundoff() [2/4]

◆ EqualToRoundoff() [3/4]

◆ EqualToRoundoff() [4/4]

◆ FahrenheitToCelsius()

◆ FeetToMeters()

◆ GaussianRandomNumber()

◆ GetVersion()

◆ KelvinToCelsius()

◆ KelvinToFahrenheit()

◆ KelvinToRankine()

◆ MachFromImpactPressure()

◆ MachFromVcalibrated()

◆ PitotTotalPressure()

◆ ProcessMessage()

◆ ProcessNextMessage()

◆ PutMessage() [1/5]

◆ PutMessage() [2/5]

◆ PutMessage() [3/5]

◆ PutMessage() [4/5]

◆ PutMessage() [5/5]

◆ RankineToCelsius()

◆ RankineToKelvin()

◆ sign()

◆ SomeMessages()

◆ VcalibratedFromMach()

Member Data Documentation

◆ debug_lvl

◆ degtorad

◆ fgblue

◆ fgcyan

◆ fgdef

◆ fggreen

◆ fgred

◆ fpstokts

◆ fttom

◆ gaussian_random_number_phase

◆ halfint

◆ highint

◆ hptoftlbssec

◆ in3tom3

◆ inchtoft

◆ inhgtopa

◆ JSBSim_version

◆ kgtolb

◆ kgtoslug

◆ ktstofps

◆ lbtoslug

◆ localMsg

◆ m3toft3

◆ messageId

◆ Messages

◆ needed_cfg_version

◆ normint