FlightGear: JSBSim::FGModel Class Reference

Base class for all scheduled JSBSim models. More...

#include <FGModel.h>

Inherited by JSBSim::FGAccelerations, JSBSim::FGAerodynamics, JSBSim::FGAircraft, JSBSim::FGAtmosphere, JSBSim::FGAuxiliary, JSBSim::FGBuoyantForces, JSBSim::FGExternalReactions, JSBSim::FGFCS, JSBSim::FGGroundReactions, JSBSim::FGInertial, JSBSim::FGInput, JSBSim::FGInputType, JSBSim::FGMassBalance, JSBSim::FGOutput, JSBSim::FGOutputType, JSBSim::FGPropagate, JSBSim::FGPropulsion, and JSBSim::FGWinds.

Public Member Functions
	FGModel (FGFDMExec *)
	Constructor.

	~FGModel () override
	Destructor.

virtual bool	Run (bool Holding)
	Runs the model; called by the Executive.

bool	InitModel (void) override

void	SetRate (unsigned int tt)
	Set the ouput rate for the model in frames.

unsigned int	GetRate (void)
	Get the output rate for the model in frames.

FGFDMExec *	GetExec (void)

void	SetPropertyManager (FGPropertyManager *fgpm)

virtual SGPath	FindFullPathName (const SGPath &path) const

const std::string &	GetName (void)

virtual bool	Load (Element *el)

Public Member Functions inherited from JSBSim::FGModelFunctions
virtual	~FGModelFunctions ()

void	RunPreFunctions (void)

void	RunPostFunctions (void)

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

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

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

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.

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

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
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.

virtual void	Debug (int from)

Protected Attributes
unsigned int	exe_ctr

unsigned int	rate

std::string	Name

FGFDMExec *	FDMExec

FGPropertyManager *	PropertyManager

Protected Attributes inherited from JSBSim::FGModelFunctions
std::vector< FGFunction * >	PreFunctions

std::vector< FGFunction * >	PostFunctions

FGPropertyReader	LocalProperties

Additional Inherited Members
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)

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

Base class for all scheduled JSBSim models.

Author: Jon S. Berndt

Definition at line 68 of file FGModel.h.

Constructor & Destructor Documentation

◆ FGModel()

JSBSim::FGModel::FGModel ( FGFDMExec * fdmex )

explicit

Constructor.

Definition at line 57 of file FGModel.cpp.

◆ ~FGModel()

JSBSim::FGModel::~FGModel ( )

override

Destructor.

Definition at line 74 of file FGModel.cpp.

Member Function Documentation

◆ Debug()

void JSBSim::FGModel::Debug ( int from )

protectedvirtual

Reimplemented in JSBSim::FGAtmosphere, JSBSim::FGInputType, JSBSim::FGOutputType, and JSBSim::FGStandardAtmosphere.

Definition at line 170 of file FGModel.cpp.

◆ FindFullPathName()

SGPath JSBSim::FGModel::FindFullPathName ( const SGPath & path ) const

virtual

Reimplemented in JSBSim::FGFCS, JSBSim::FGOutput, and JSBSim::FGPropulsion.

Definition at line 103 of file FGModel.cpp.

◆ GetExec()

FGFDMExec * JSBSim::FGModel::GetExec ( void )

inline

Definition at line 93 of file FGModel.h.

◆ GetName()

const std::string & JSBSim::FGModel::GetName ( void )

inline

Definition at line 97 of file FGModel.h.

◆ GetRate()

unsigned int JSBSim::FGModel::GetRate ( void )

inline

Get the output rate for the model in frames.

Definition at line 92 of file FGModel.h.

◆ InitModel()

bool JSBSim::FGModel::InitModel ( void )

overridevirtual

Reimplemented from JSBSim::FGModelFunctions.

Reimplemented in JSBSim::FGOutput, JSBSim::FGOutputFile, JSBSim::FGOutputSocket, JSBSim::FGOutputType, JSBSim::FGPropagate, JSBSim::FGPropulsion, JSBSim::FGStandardAtmosphere, and JSBSim::FGWinds.

Definition at line 81 of file FGModel.cpp.

◆ Load()

virtual bool JSBSim::FGModel::Load ( Element * el )

inlinevirtual

◆ Run()

bool JSBSim::FGModel::Run ( bool Holding )

virtual

Runs the model; called by the Executive.

Can pass in a value indicating if the executive is directing the simulation to Hold.

Parameters

Holding if true, the executive has been directed to hold the sim from advancing time. Some models may ignore this flag, such as the Input model, which may need to be active to listen on a socket for the "Resume" command to be given. The Holding flag is not used in the base FGModel class.

See also: JSBSim.cpp documentation

Returns: false if no error

Reimplemented in JSBSim::FGAccelerations, JSBSim::FGAerodynamics, JSBSim::FGAircraft, JSBSim::FGAtmosphere, JSBSim::FGAuxiliary, JSBSim::FGBuoyantForces, JSBSim::FGExternalReactions, JSBSim::FGFCS, JSBSim::FGGroundReactions, JSBSim::FGInertial, JSBSim::FGInput, JSBSim::FGInputType, JSBSim::FGMassBalance, JSBSim::FGOutput, JSBSim::FGPropagate, JSBSim::FGPropulsion, and JSBSim::FGWinds.

Definition at line 89 of file FGModel.cpp.

◆ SetPropertyManager()

void JSBSim::FGModel::SetPropertyManager ( FGPropertyManager * fgpm )

inline

Definition at line 95 of file FGModel.h.

◆ SetRate()

void JSBSim::FGModel::SetRate ( unsigned int tt )

inline

Set the ouput rate for the model in frames.

Definition at line 90 of file FGModel.h.

◆ Upload()

bool JSBSim::FGModel::Upload	(	Element *	el,
		bool	preLoad )

protected

Uploads this model in memory.

Uploads the model in memory if its contents are contained in a separate file.

Parameters

el	a pointer to the element
preLoad	true if model functions and local properties must be preloaded.

Returns: true if model is successfully loaded

Definition at line 110 of file FGModel.cpp.

Member Data Documentation

◆ exe_ctr

unsigned int JSBSim::FGModel::exe_ctr

protected

Definition at line 101 of file FGModel.h.

◆ FDMExec

FGFDMExec* JSBSim::FGModel::FDMExec

protected

Definition at line 116 of file FGModel.h.

◆ Name

std::string JSBSim::FGModel::Name

protected

Definition at line 103 of file FGModel.h.

◆ PropertyManager

FGPropertyManager* JSBSim::FGModel::PropertyManager

protected

Definition at line 117 of file FGModel.h.

◆ rate

unsigned int JSBSim::FGModel::rate

protected

Definition at line 102 of file FGModel.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FGModel()

◆ ~FGModel()

Member Function Documentation

◆ Debug()

◆ FindFullPathName()

◆ GetExec()

◆ GetName()

◆ GetRate()

◆ InitModel()

◆ Load()

◆ Run()

◆ SetPropertyManager()

◆ SetRate()

◆ Upload()

Member Data Documentation

◆ exe_ctr

◆ FDMExec

◆ Name

◆ PropertyManager

◆ rate