JSBSim::FGTrimAxis Class Reference

#include <FGTrimAxis.h>

Inherits JSBSim::FGJSBBase.

Public Member Functions
	FGTrimAxis (FGFDMExec *fdmex, FGInitialCondition *IC, State state, Control control)
	Constructor for Trim Axis class.
	~FGTrimAxis ()
	Destructor.
void	Run (void)
	This function iterates through a call to the FGFDMExec::RunIC() function until the desired trimming condition falls inside a tolerance.
double	GetState (void)
void	SetControl (double value)
double	GetControl (void)
State	GetStateType (void)
Control	GetControlType (void)
std::string	GetStateName (void)
std::string	GetControlName (void)
double	GetControlMin (void)
double	GetControlMax (void)
void	SetControlToMin (void)
void	SetControlToMax (void)
void	SetControlLimits (double min, double max)
void	SetTolerance (double ff)
double	GetTolerance (void)
double	GetSolverEps (void)
void	SetSolverEps (double ff)
int	GetIterationLimit (void)
void	SetIterationLimit (int ii)
int	GetStability (void)
int	GetRunCount (void)
double	GetAvgStability (void)
void	SetStateTarget (double target)
double	GetStateTarget (void)
void	AxisReport (void)
bool	InTolerance (void)
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.

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/(fttom*fttom*fttom)
static constexpr double	in3tom3 = inchtoft*inchtoft*inchtoft/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

Definition at line 87 of file FGTrimAxis.h.

Constructor & Destructor Documentation

FGTrimAxis()

JSBSim::FGTrimAxis::FGTrimAxis	(	FGFDMExec *	fdmex,
		FGInitialCondition *	IC,
		State	state,
		Control	control )

Constructor for Trim Axis class.

Parameters

fdmex	FGFDMExec pointer
IC	pointer to initial conditions instance
state	a State type (enum)
control	a Control type (enum)

Definition at line 61 of file FGTrimAxis.cpp.

~FGTrimAxis()

JSBSim::FGTrimAxis::~FGTrimAxis

(

void

)

Destructor.

Definition at line 159 of file FGTrimAxis.cpp.

Member Function Documentation

AxisReport()

void JSBSim::FGTrimAxis::AxisReport

(

void

)

Definition at line 291 of file FGTrimAxis.cpp.

GetAvgStability()

double JSBSim::FGTrimAxis::GetAvgStability

(

void

)

Definition at line 314 of file FGTrimAxis.cpp.

GetControl()

double JSBSim::FGTrimAxis::GetControl ( void )

inline

Definition at line 109 of file FGTrimAxis.h.

GetControlMax()

double JSBSim::FGTrimAxis::GetControlMax ( void )

inline

Definition at line 118 of file FGTrimAxis.h.

GetControlMin()

double JSBSim::FGTrimAxis::GetControlMin ( void )

inline

Definition at line 117 of file FGTrimAxis.h.

GetControlName()

std::string JSBSim::FGTrimAxis::GetControlName ( void )

inline

Definition at line 115 of file FGTrimAxis.h.

GetControlType()

Control JSBSim::FGTrimAxis::GetControlType ( void )

inline

Definition at line 112 of file FGTrimAxis.h.

GetIterationLimit()

int JSBSim::FGTrimAxis::GetIterationLimit ( void )

inline

Definition at line 134 of file FGTrimAxis.h.

GetRunCount()

int JSBSim::FGTrimAxis::GetRunCount ( void )

inline

Definition at line 138 of file FGTrimAxis.h.

GetSolverEps()

double JSBSim::FGTrimAxis::GetSolverEps ( void )

inline

Definition at line 131 of file FGTrimAxis.h.

GetStability()

int JSBSim::FGTrimAxis::GetStability ( void )

inline

Definition at line 137 of file FGTrimAxis.h.

GetState()

double JSBSim::FGTrimAxis::GetState ( void )

inline

Definition at line 106 of file FGTrimAxis.h.

GetStateName()

std::string JSBSim::FGTrimAxis::GetStateName ( void )

inline

Definition at line 114 of file FGTrimAxis.h.

GetStateTarget()

double JSBSim::FGTrimAxis::GetStateTarget ( void )

inline

Definition at line 142 of file FGTrimAxis.h.

GetStateType()

State JSBSim::FGTrimAxis::GetStateType ( void )

inline

Definition at line 111 of file FGTrimAxis.h.

GetTolerance()

double JSBSim::FGTrimAxis::GetTolerance ( void )

inline

Definition at line 129 of file FGTrimAxis.h.

InTolerance()

bool JSBSim::FGTrimAxis::InTolerance ( void )

inline

Definition at line 146 of file FGTrimAxis.h.

Run()

void JSBSim::FGTrimAxis::Run

(

void

)

This function iterates through a call to the FGFDMExec::RunIC() function until the desired trimming condition falls inside a tolerance.

Definition at line 245 of file FGTrimAxis.cpp.

SetControl()

void JSBSim::FGTrimAxis::SetControl ( double value )

inline

Definition at line 108 of file FGTrimAxis.h.

SetControlLimits()

void JSBSim::FGTrimAxis::SetControlLimits ( double min, double max )

inline

Definition at line 123 of file FGTrimAxis.h.

SetControlToMax()

void JSBSim::FGTrimAxis::SetControlToMax ( void )

inline

Definition at line 121 of file FGTrimAxis.h.

SetControlToMin()

void JSBSim::FGTrimAxis::SetControlToMin ( void )

inline

Definition at line 120 of file FGTrimAxis.h.

SetIterationLimit()

void JSBSim::FGTrimAxis::SetIterationLimit ( int ii )

inline

Definition at line 135 of file FGTrimAxis.h.

SetSolverEps()

void JSBSim::FGTrimAxis::SetSolverEps ( double ff )

inline

Definition at line 132 of file FGTrimAxis.h.

SetStateTarget()

void JSBSim::FGTrimAxis::SetStateTarget ( double target )

inline

Definition at line 141 of file FGTrimAxis.h.

SetTolerance()

void JSBSim::FGTrimAxis::SetTolerance ( double ff )

inline

Definition at line 128 of file FGTrimAxis.h.

---

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

• FGTrimAxis.h
• FGTrimAxis.cpp