FlightGear: JSBSim::FGInitialCondition Class Reference

#include <FGInitialCondition.h>

Public Member Functions
	FGInitialCondition (FGFDMExec *fdmex)
	Constructor.

	~FGInitialCondition ()
	Destructor.

void	SetVcalibratedKtsIC (double vc)
	Set calibrated airspeed initial condition in knots.

void	SetVequivalentKtsIC (double ve)
	Set equivalent airspeed initial condition in knots.

void	SetVtrueKtsIC (double vtrue)
	Set true airspeed initial condition in knots.

void	SetVgroundKtsIC (double vg)
	Set ground speed initial condition in knots.

void	SetMachIC (double mach)
	Set mach initial condition.

void	SetAlphaDegIC (double a)
	Sets angle of attack initial condition in degrees.

void	SetBetaDegIC (double b)
	Sets angle of sideslip initial condition in degrees.

void	SetThetaDegIC (double theta)
	Sets pitch angle initial condition in degrees.

void	ResetIC (double u0, double v0, double w0, double p0, double q0, double r0, double alpha0, double beta0, double phi0, double theta0, double psi0, double latitudeRad0, double longitudeRad0, double altitudeAGL0, double gamma0)
	Resets the IC data structure to new values.

void	SetPhiDegIC (double phi)
	Sets the roll angle initial condition in degrees.

void	SetPsiDegIC (double psi)
	Sets the heading angle initial condition in degrees.

void	SetClimbRateFpmIC (double roc)
	Sets the climb rate initial condition in feet/minute.

void	SetFlightPathAngleDegIC (double gamma)
	Sets the flight path angle initial condition in degrees.

void	SetAltitudeASLFtIC (double altitudeASL)
	Sets the altitude above sea level initial condition in feet.

void	SetAltitudeAGLFtIC (double agl)
	Sets the initial Altitude above ground level.

void	SetTerrainElevationFtIC (double elev)
	Sets the initial terrain elevation.

void	SetLatitudeDegIC (double lat)
	Sets the initial latitude.

void	SetGeodLatitudeDegIC (double glat)
	Sets the initial geodetic latitude.

void	SetLongitudeDegIC (double lon)
	Sets the initial longitude.

double	GetVcalibratedKtsIC (void) const
	Gets the initial calibrated airspeed.

double	GetVequivalentKtsIC (void) const
	Gets the initial equivalent airspeed.

double	GetVgroundKtsIC (void) const
	Gets the initial ground speed.

double	GetVtrueKtsIC (void) const
	Gets the initial true velocity.

double	GetMachIC (void) const
	Gets the initial mach.

double	GetClimbRateFpmIC (void) const
	Gets the initial climb rate.

double	GetFlightPathAngleDegIC (void) const
	Gets the initial flight path angle.

double	GetAlphaDegIC (void) const
	Gets the initial angle of attack.

double	GetBetaDegIC (void) const
	Gets the initial sideslip angle.

double	GetThetaDegIC (void) const
	Gets the initial pitch angle.

double	GetPhiDegIC (void) const
	Gets the initial roll angle.

double	GetPsiDegIC (void) const
	Gets the initial heading angle.

double	GetLatitudeDegIC (void) const
	Gets the initial latitude.

double	GetGeodLatitudeDegIC (void) const
	Gets the initial geodetic latitude.

double	GetLongitudeDegIC (void) const
	Gets the initial longitude.

double	GetAltitudeASLFtIC (void) const
	Gets the initial altitude above sea level.

double	GetAltitudeAGLFtIC (void) const
	Gets the initial altitude above ground level.

double	GetTerrainElevationFtIC (void) const
	Gets the initial terrain elevation.

double	GetEarthPositionAngleIC (void) const
	Gets the initial Earth position angle.

void	SetVgroundFpsIC (double vg)
	Sets the initial ground speed.

void	SetVtrueFpsIC (double vt)
	Sets the initial true airspeed.

void	SetUBodyFpsIC (double ubody)
	Sets the initial body axis X velocity.

void	SetVBodyFpsIC (double vbody)
	Sets the initial body axis Y velocity.

void	SetWBodyFpsIC (double wbody)
	Sets the initial body axis Z velocity.

void	SetVNorthFpsIC (double vn)
	Sets the initial local axis north velocity.

void	SetVEastFpsIC (double ve)
	Sets the initial local axis east velocity.

void	SetVDownFpsIC (double vd)
	Sets the initial local axis down velocity.

void	SetPRadpsIC (double P)
	Sets the initial body axis roll rate.

void	SetQRadpsIC (double Q)
	Sets the initial body axis pitch rate.

void	SetRRadpsIC (double R)
	Sets the initial body axis yaw rate.

void	SetWindNEDFpsIC (double wN, double wE, double wD)
	Sets the initial wind velocity.

void	SetWindMagKtsIC (double mag)
	Sets the initial total wind speed.

void	SetWindDirDegIC (double dir)
	Sets the initial wind direction.

void	SetHeadWindKtsIC (double head)
	Sets the initial headwind velocity.

void	SetCrossWindKtsIC (double cross)
	Sets the initial crosswind speed.

void	SetWindDownKtsIC (double wD)
	Sets the initial wind downward speed.

void	SetClimbRateFpsIC (double roc)
	Sets the initial climb rate.

double	GetVgroundFpsIC (void) const
	Gets the initial ground velocity.

double	GetVtrueFpsIC (void) const
	Gets the initial true velocity.

double	GetWindUFpsIC (void) const
	Gets the initial body axis X wind velocity.

double	GetWindVFpsIC (void) const
	Gets the initial body axis Y wind velocity.

double	GetWindWFpsIC (void) const
	Gets the initial body axis Z wind velocity.

const FGColumnVector3	GetWindNEDFpsIC (void) const
	Gets the initial wind velocity in the NED local frame.

double	GetWindNFpsIC (void) const
	Gets the initial wind velocity in local frame.

double	GetWindEFpsIC (void) const
	Gets the initial wind velocity in local frame.

double	GetWindDFpsIC (void) const
	Gets the initial wind velocity in local frame.

double	GetWindFpsIC (void) const
	Gets the initial total wind velocity in feet/sec.

double	GetWindDirDegIC (void) const
	Gets the initial wind direction.

double	GetClimbRateFpsIC (void) const
	Gets the initial climb rate.

const FGColumnVector3	GetUVWFpsIC (void) const
	Gets the initial body velocity.

double	GetUBodyFpsIC (void) const
	Gets the initial body axis X velocity.

double	GetVBodyFpsIC (void) const
	Gets the initial body axis Y velocity.

double	GetWBodyFpsIC (void) const
	Gets the initial body axis Z velocity.

double	GetVNorthFpsIC (void) const
	Gets the initial local frame X (North) velocity.

double	GetVEastFpsIC (void) const
	Gets the initial local frame Y (East) velocity.

double	GetVDownFpsIC (void) const
	Gets the initial local frame Z (Down) velocity.

const FGColumnVector3	GetPQRRadpsIC (void) const
	Gets the initial body rotation rate.

double	GetPRadpsIC () const
	Gets the initial body axis roll rate.

double	GetQRadpsIC () const
	Gets the initial body axis pitch rate.

double	GetRRadpsIC () const
	Gets the initial body axis yaw rate.

void	SetFlightPathAngleRadIC (double gamma)
	Sets the initial flight path angle.

void	SetAlphaRadIC (double alpha)
	Sets the initial angle of attack.

void	SetBetaRadIC (double beta)
	Sets the initial sideslip angle.

void	SetPhiRadIC (double phi)
	Sets the initial roll angle.

void	SetThetaRadIC (double theta)
	Sets the initial pitch angle.

void	SetPsiRadIC (double psi)
	Sets the initial heading angle.

void	SetLatitudeRadIC (double lat)
	Sets the initial latitude.

void	SetGeodLatitudeRadIC (double glat)
	Sets the initial geodetic latitude.

void	SetLongitudeRadIC (double lon)
	Sets the initial longitude.

void	SetTargetNlfIC (double nlf)
	Sets the target normal load factor.

double	GetFlightPathAngleRadIC (void) const
	Gets the initial flight path angle.

double	GetAlphaRadIC (void) const
	Gets the initial angle of attack.

double	GetBetaRadIC (void) const
	Gets the initial angle of sideslip.

const FGLocation &	GetPosition (void) const
	Gets the initial position.

double	GetLatitudeRadIC (void) const
	Gets the initial latitude.

double	GetGeodLatitudeRadIC (void) const
	Gets the initial geodetic latitude.

double	GetLongitudeRadIC (void) const
	Gets the initial longitude.

const FGQuaternion &	GetOrientation (void) const
	Gets the initial orientation.

double	GetPhiRadIC (void) const
	Gets the initial roll angle.

double	GetThetaRadIC (void) const
	Gets the initial pitch angle.

double	GetPsiRadIC (void) const
	Gets the initial heading angle.

speedset	GetSpeedSet (void) const
	Gets the initial speedset.

double	GetTargetNlfIC (void) const
	Gets the target normal load factor set from IC.

bool	Load (const SGPath &rstname, bool useStoredPath=true)
	Loads the initial conditions.

bool	IsEngineRunning (unsigned int n) const
	Is an engine running ?

int	TrimRequested (void) const
	Does initialization file call for trim ?

void	InitializeIC (void)
	Initialize the initial conditions to default values.

void	bind (FGPropertyManager *pm)

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

Definition at line 224 of file FGInitialCondition.h.

Constructor & Destructor Documentation

◆ FGInitialCondition()

JSBSim::FGInitialCondition::FGInitialCondition ( FGFDMExec * fdmex )

explicit

Constructor.

Definition at line 60 of file FGInitialCondition.cpp.

◆ ~FGInitialCondition()

JSBSim::FGInitialCondition::~FGInitialCondition ( )

Destructor.

Definition at line 76 of file FGInitialCondition.cpp.

Member Function Documentation

◆ bind()

void JSBSim::FGInitialCondition::bind ( FGPropertyManager * pm )

Definition at line 1445 of file FGInitialCondition.cpp.

◆ GetAlphaDegIC()

double JSBSim::FGInitialCondition::GetAlphaDegIC ( void ) const

inline

Gets the initial angle of attack.

Returns: Initial alpha in degrees

Definition at line 347 of file FGInitialCondition.h.

◆ GetAlphaRadIC()

double JSBSim::FGInitialCondition::GetAlphaRadIC ( void ) const

inline

Gets the initial angle of attack.

Returns: Initial alpha in radians

Definition at line 623 of file FGInitialCondition.h.

◆ GetAltitudeAGLFtIC()

double JSBSim::FGInitialCondition::GetAltitudeAGLFtIC ( void ) const

Gets the initial altitude above ground level.

Returns: Initial altitude AGL in feet

Definition at line 656 of file FGInitialCondition.cpp.

◆ GetAltitudeASLFtIC()

double JSBSim::FGInitialCondition::GetAltitudeASLFtIC ( void ) const

Gets the initial altitude above sea level.

Returns: Initial altitude in feet.

Definition at line 649 of file FGInitialCondition.cpp.

◆ GetBetaDegIC()

double JSBSim::FGInitialCondition::GetBetaDegIC ( void ) const

inline

Gets the initial sideslip angle.

Returns: Initial beta in degrees

Definition at line 351 of file FGInitialCondition.h.

◆ GetBetaRadIC()

double JSBSim::FGInitialCondition::GetBetaRadIC ( void ) const

inline

Gets the initial angle of sideslip.

Returns: Initial sideslip angle in radians

Definition at line 627 of file FGInitialCondition.h.

◆ GetClimbRateFpmIC()

double JSBSim::FGInitialCondition::GetClimbRateFpmIC ( void ) const

inline

Gets the initial climb rate.

Returns: Initial climb rate in feet/minute

Definition at line 337 of file FGInitialCondition.h.

◆ GetClimbRateFpsIC()

double JSBSim::FGInitialCondition::GetClimbRateFpsIC ( void ) const

inline

Gets the initial climb rate.

Returns: Initial rate of climb in feet/second

Definition at line 518 of file FGInitialCondition.h.

◆ GetEarthPositionAngleIC()

double JSBSim::FGInitialCondition::GetEarthPositionAngleIC ( void ) const

inline

Gets the initial Earth position angle.

Returns: Initial Earth position angle in radians.

Definition at line 392 of file FGInitialCondition.h.

◆ GetFlightPathAngleDegIC()

double JSBSim::FGInitialCondition::GetFlightPathAngleDegIC ( void ) const

inline

Gets the initial flight path angle.

Returns: Initial flight path angle in degrees

Definition at line 342 of file FGInitialCondition.h.

◆ GetFlightPathAngleRadIC()

double JSBSim::FGInitialCondition::GetFlightPathAngleRadIC ( void ) const

inline

Gets the initial flight path angle.

If total velocity is zero, this function returns zero.

Returns: Initial flight path angle in radians

Definition at line 618 of file FGInitialCondition.h.

◆ GetGeodLatitudeDegIC()

double JSBSim::FGInitialCondition::GetGeodLatitudeDegIC ( void ) const

inline

Gets the initial geodetic latitude.

Returns: Initial geodetic latitude in degrees

Definition at line 371 of file FGInitialCondition.h.

◆ GetGeodLatitudeRadIC()

double JSBSim::FGInitialCondition::GetGeodLatitudeRadIC ( void ) const

inline

Gets the initial geodetic latitude.

Returns: Initial geodetic latitude in radians

Definition at line 639 of file FGInitialCondition.h.

◆ GetLatitudeDegIC()

double JSBSim::FGInitialCondition::GetLatitudeDegIC ( void ) const

inline

Gets the initial latitude.

Returns: Initial geocentric latitude in degrees

Definition at line 367 of file FGInitialCondition.h.

◆ GetLatitudeRadIC()

double JSBSim::FGInitialCondition::GetLatitudeRadIC ( void ) const

inline

Gets the initial latitude.

Returns: Initial latitude in radians

Definition at line 635 of file FGInitialCondition.h.

◆ GetLongitudeDegIC()

double JSBSim::FGInitialCondition::GetLongitudeDegIC ( void ) const

inline

Gets the initial longitude.

Returns: Initial longitude in degrees

Definition at line 376 of file FGInitialCondition.h.

◆ GetLongitudeRadIC()

double JSBSim::FGInitialCondition::GetLongitudeRadIC ( void ) const

inline

Gets the initial longitude.

Returns: Initial longitude in radians

Definition at line 644 of file FGInitialCondition.h.

◆ GetMachIC()

double JSBSim::FGInitialCondition::GetMachIC ( void ) const

Gets the initial mach.

Returns: Initial mach number

Definition at line 983 of file FGInitialCondition.cpp.

◆ GetOrientation()

const FGQuaternion & JSBSim::FGInitialCondition::GetOrientation ( void ) const

inline

Gets the initial orientation.

Returns: Initial orientation

Definition at line 648 of file FGInitialCondition.h.

◆ GetPhiDegIC()

double JSBSim::FGInitialCondition::GetPhiDegIC ( void ) const

inline

Gets the initial roll angle.

Returns: Initial phi in degrees

Definition at line 359 of file FGInitialCondition.h.

◆ GetPhiRadIC()

double JSBSim::FGInitialCondition::GetPhiRadIC ( void ) const

inline

Gets the initial roll angle.

Returns: Initial roll angle in radians

Definition at line 652 of file FGInitialCondition.h.

◆ GetPosition()

const FGLocation & JSBSim::FGInitialCondition::GetPosition ( void ) const

inline

Gets the initial position.

Returns: Initial location

Definition at line 631 of file FGInitialCondition.h.

◆ GetPQRRadpsIC()

const FGColumnVector3 JSBSim::FGInitialCondition::GetPQRRadpsIC ( void ) const

inline

Gets the initial body rotation rate.

Returns: Initial body rotation rate in radians/second

Definition at line 558 of file FGInitialCondition.h.

◆ GetPRadpsIC()

double JSBSim::FGInitialCondition::GetPRadpsIC ( ) const

inline

Gets the initial body axis roll rate.

Returns: Initial body axis roll rate in radians/second

Definition at line 562 of file FGInitialCondition.h.

◆ GetPsiDegIC()

double JSBSim::FGInitialCondition::GetPsiDegIC ( void ) const

inline

Gets the initial heading angle.

Returns: Initial psi in degrees

Definition at line 363 of file FGInitialCondition.h.

◆ GetPsiRadIC()

double JSBSim::FGInitialCondition::GetPsiRadIC ( void ) const

inline

Gets the initial heading angle.

Returns: Initial heading angle in radians

Definition at line 660 of file FGInitialCondition.h.

◆ GetQRadpsIC()

double JSBSim::FGInitialCondition::GetQRadpsIC ( ) const

inline

Gets the initial body axis pitch rate.

Returns: Initial body axis pitch rate in radians/second

Definition at line 566 of file FGInitialCondition.h.

◆ GetRRadpsIC()

double JSBSim::FGInitialCondition::GetRRadpsIC ( ) const

inline

Gets the initial body axis yaw rate.

Returns: Initial body axis yaw rate in radians/second

Definition at line 570 of file FGInitialCondition.h.

◆ GetSpeedSet()

speedset JSBSim::FGInitialCondition::GetSpeedSet ( void ) const

inline

Gets the initial speedset.

Returns: Initial speedset

Definition at line 664 of file FGInitialCondition.h.

◆ GetTargetNlfIC()

double JSBSim::FGInitialCondition::GetTargetNlfIC ( void ) const

inline

Gets the target normal load factor set from IC.

Returns: target normal load factor set from IC

Definition at line 668 of file FGInitialCondition.h.

◆ GetTerrainElevationFtIC()

double JSBSim::FGInitialCondition::GetTerrainElevationFtIC ( void ) const

Gets the initial terrain elevation.

Returns: Initial terrain elevation in feet

Definition at line 663 of file FGInitialCondition.cpp.

◆ GetThetaDegIC()

double JSBSim::FGInitialCondition::GetThetaDegIC ( void ) const

inline

Gets the initial pitch angle.

Returns: Initial pitch angle in degrees

Definition at line 355 of file FGInitialCondition.h.

◆ GetThetaRadIC()

double JSBSim::FGInitialCondition::GetThetaRadIC ( void ) const

inline

Gets the initial pitch angle.

Returns: Initial pitch angle in radians

Definition at line 656 of file FGInitialCondition.h.

◆ GetUBodyFpsIC()

double JSBSim::FGInitialCondition::GetUBodyFpsIC ( void ) const

inline

Gets the initial body axis X velocity.

Returns: Initial body axis X velocity in feet/second.

Definition at line 534 of file FGInitialCondition.h.

◆ GetUVWFpsIC()

const FGColumnVector3 JSBSim::FGInitialCondition::GetUVWFpsIC ( void ) const

inline

Gets the initial body velocity.

Returns: Initial body velocity in feet/second.

Definition at line 527 of file FGInitialCondition.h.

◆ GetVBodyFpsIC()

double JSBSim::FGInitialCondition::GetVBodyFpsIC ( void ) const

inline

Gets the initial body axis Y velocity.

Returns: Initial body axis Y velocity in feet/second.

Definition at line 538 of file FGInitialCondition.h.

◆ GetVcalibratedKtsIC()

double JSBSim::FGInitialCondition::GetVcalibratedKtsIC ( void ) const

Gets the initial calibrated airspeed.

Returns: Initial calibrated airspeed in knots

Definition at line 961 of file FGInitialCondition.cpp.

◆ GetVDownFpsIC()

double JSBSim::FGInitialCondition::GetVDownFpsIC ( void ) const

inline

Gets the initial local frame Z (Down) velocity.

Returns: Initial local frame Z (Down) axis velocity in feet/second.

Definition at line 554 of file FGInitialCondition.h.

◆ GetVEastFpsIC()

double JSBSim::FGInitialCondition::GetVEastFpsIC ( void ) const

inline

Gets the initial local frame Y (East) velocity.

Returns: Initial local frame Y (East) axis velocity in feet/second.

Definition at line 550 of file FGInitialCondition.h.

◆ GetVequivalentKtsIC()

double JSBSim::FGInitialCondition::GetVequivalentKtsIC ( void ) const

Gets the initial equivalent airspeed.

Returns: Initial equivalent airspeed in knots

Definition at line 973 of file FGInitialCondition.cpp.

◆ GetVgroundFpsIC()

double JSBSim::FGInitialCondition::GetVgroundFpsIC ( void ) const

inline

Gets the initial ground velocity.

Returns: Initial ground velocity in feet/second

Definition at line 470 of file FGInitialCondition.h.

◆ GetVgroundKtsIC()

double JSBSim::FGInitialCondition::GetVgroundKtsIC ( void ) const

inline

Gets the initial ground speed.

Returns: Initial ground speed in knots

Definition at line 325 of file FGInitialCondition.h.

◆ GetVNorthFpsIC()

double JSBSim::FGInitialCondition::GetVNorthFpsIC ( void ) const

inline

Gets the initial local frame X (North) velocity.

Returns: Initial local frame X (North) axis velocity in feet/second.

Definition at line 546 of file FGInitialCondition.h.

◆ GetVtrueFpsIC()

double JSBSim::FGInitialCondition::GetVtrueFpsIC ( void ) const

inline

Gets the initial true velocity.

Returns: Initial true velocity in feet/second

Definition at line 474 of file FGInitialCondition.h.

◆ GetVtrueKtsIC()

double JSBSim::FGInitialCondition::GetVtrueKtsIC ( void ) const

inline

Gets the initial true velocity.

Returns: Initial true airspeed in knots.

Definition at line 329 of file FGInitialCondition.h.

◆ GetWBodyFpsIC()

double JSBSim::FGInitialCondition::GetWBodyFpsIC ( void ) const

inline

Gets the initial body axis Z velocity.

Returns: Initial body axis Z velocity in feet/second.

Definition at line 542 of file FGInitialCondition.h.

◆ GetWindDFpsIC()

double JSBSim::FGInitialCondition::GetWindDFpsIC ( void ) const

inline

Gets the initial wind velocity in local frame.

Returns: Initial wind velocity downwards in feet/second

Definition at line 506 of file FGInitialCondition.h.

◆ GetWindDirDegIC()

double JSBSim::FGInitialCondition::GetWindDirDegIC ( void ) const

Gets the initial wind direction.

Returns: Initial wind direction in feet/second

Definition at line 915 of file FGInitialCondition.cpp.

◆ GetWindEFpsIC()

double JSBSim::FGInitialCondition::GetWindEFpsIC ( void ) const

inline

Gets the initial wind velocity in local frame.

Returns: Initial wind velocity eastwards in feet/second

Definition at line 502 of file FGInitialCondition.h.

◆ GetWindFpsIC()

double JSBSim::FGInitialCondition::GetWindFpsIC ( void ) const

Gets the initial total wind velocity in feet/sec.

Returns: Initial wind velocity in feet/second

Definition at line 938 of file FGInitialCondition.cpp.

◆ GetWindNEDFpsIC()

const FGColumnVector3 JSBSim::FGInitialCondition::GetWindNEDFpsIC ( void ) const

inline

Gets the initial wind velocity in the NED local frame.

Returns: Initial wind velocity in NED frame in feet/second

Definition at line 490 of file FGInitialCondition.h.

◆ GetWindNFpsIC()

double JSBSim::FGInitialCondition::GetWindNFpsIC ( void ) const

inline

Gets the initial wind velocity in local frame.

Returns: Initial wind velocity toward north in feet/second

Definition at line 498 of file FGInitialCondition.h.

◆ GetWindUFpsIC()

double JSBSim::FGInitialCondition::GetWindUFpsIC ( void ) const

inline

Gets the initial body axis X wind velocity.

Returns: Initial body axis X wind velocity in feet/second

Definition at line 478 of file FGInitialCondition.h.

◆ GetWindVFpsIC()

double JSBSim::FGInitialCondition::GetWindVFpsIC ( void ) const

inline

Gets the initial body axis Y wind velocity.

Returns: Initial body axis Y wind velocity in feet/second

Definition at line 482 of file FGInitialCondition.h.

◆ GetWindWFpsIC()

double JSBSim::FGInitialCondition::GetWindWFpsIC ( void ) const

inline

Gets the initial body axis Z wind velocity.

Returns: Initial body axis Z wind velocity in feet/second

Definition at line 486 of file FGInitialCondition.h.

◆ InitializeIC()

void JSBSim::FGInitialCondition::InitializeIC ( void )

Initialize the initial conditions to default values.

Definition at line 121 of file FGInitialCondition.cpp.

◆ IsEngineRunning()

bool JSBSim::FGInitialCondition::IsEngineRunning ( unsigned int n ) const

inline

Is an engine running ?

Parameters

index of the engine to be checked

Returns: true if the engine is running.

Definition at line 679 of file FGInitialCondition.h.

◆ Load()

bool JSBSim::FGInitialCondition::Load	(	const SGPath &	rstname,
		bool	useStoredPath = true )

Loads the initial conditions.

Parameters

rstname	The name of an initial conditions file
useStoredPath	true if the stored path to the IC file should be used

Returns: true if successful

Definition at line 1002 of file FGInitialCondition.cpp.

◆ ResetIC()

void JSBSim::FGInitialCondition::ResetIC	(	double	u0,
		double	v0,
		double	w0,
		double	p0,
		double	q0,
		double	r0,
		double	alpha0,
		double	beta0,
		double	phi0,
		double	theta0,
		double	psi0,
		double	latitudeRad0,
		double	longitudeRad0,
		double	altitudeAGL0,
		double	gamma0 )

Resets the IC data structure to new values.

Parameters

u,v,w,...

Definition at line 83 of file FGInitialCondition.cpp.

◆ SetAlphaDegIC()

void JSBSim::FGInitialCondition::SetAlphaDegIC ( double a )

inline

Sets angle of attack initial condition in degrees.

Parameters

a	Alpha in degrees

Definition at line 254 of file FGInitialCondition.h.

◆ SetAlphaRadIC()

void JSBSim::FGInitialCondition::SetAlphaRadIC ( double alpha )

Sets the initial angle of attack.

Parameters

alpha Initial angle of attack in radians

Definition at line 312 of file FGInitialCondition.cpp.

◆ SetAltitudeAGLFtIC()

void JSBSim::FGInitialCondition::SetAltitudeAGLFtIC ( double agl )

Sets the initial Altitude above ground level.

Parameters

agl	Altitude above ground level in feet

Definition at line 676 of file FGInitialCondition.cpp.

◆ SetAltitudeASLFtIC()

void JSBSim::FGInitialCondition::SetAltitudeASLFtIC ( double altitudeASL )

Sets the altitude above sea level initial condition in feet.

Parameters

altitudeASL Altitude above sea level in feet

Definition at line 748 of file FGInitialCondition.cpp.

◆ SetBetaDegIC()

void JSBSim::FGInitialCondition::SetBetaDegIC ( double b )

inline

Sets angle of sideslip initial condition in degrees.

Parameters

B	Beta in degrees

Definition at line 258 of file FGInitialCondition.h.

◆ SetBetaRadIC()

void JSBSim::FGInitialCondition::SetBetaRadIC ( double beta )

Sets the initial sideslip angle.

Parameters

beta	Initial angle of sideslip in radians.

Definition at line 397 of file FGInitialCondition.cpp.

◆ SetClimbRateFpmIC()

void JSBSim::FGInitialCondition::SetClimbRateFpmIC ( double roc )

inline

Sets the climb rate initial condition in feet/minute.

Parameters

roc	Rate of Climb in feet/minute

Definition at line 281 of file FGInitialCondition.h.

◆ SetClimbRateFpsIC()

void JSBSim::FGInitialCondition::SetClimbRateFpsIC ( double roc )

Sets the initial climb rate.

Parameters

roc	Initial Rate of climb in feet/second

Definition at line 283 of file FGInitialCondition.cpp.

◆ SetCrossWindKtsIC()

void JSBSim::FGInitialCondition::SetCrossWindKtsIC ( double cross )

Sets the initial crosswind speed.

Parameters

cross Initial crosswind speed, positive from left to right

Definition at line 527 of file FGInitialCondition.cpp.

◆ SetFlightPathAngleDegIC()

void JSBSim::FGInitialCondition::SetFlightPathAngleDegIC ( double gamma )

inline

Sets the flight path angle initial condition in degrees.

Parameters

gamma Flight path angle in degrees

Definition at line 285 of file FGInitialCondition.h.

◆ SetFlightPathAngleRadIC()

void JSBSim::FGInitialCondition::SetFlightPathAngleRadIC ( double gamma )

inline

Sets the initial flight path angle.

Parameters

gamma Initial flight path angle in radians

Definition at line 574 of file FGInitialCondition.h.

◆ SetGeodLatitudeDegIC()

void JSBSim::FGInitialCondition::SetGeodLatitudeDegIC ( double glat )

inline

Sets the initial geodetic latitude.

This method modifies the geodetic altitude in order to keep the altitude above sea level unchanged.

Parameters

glat	Initial geodetic latitude in degrees

Definition at line 308 of file FGInitialCondition.h.

◆ SetGeodLatitudeRadIC()

void JSBSim::FGInitialCondition::SetGeodLatitudeRadIC ( double glat )

Sets the initial geodetic latitude.

This method modifies the geodetic altitude in order to keep the altitude above sea level unchanged.

Parameters

glat	Initial geodetic latitude in radians

Definition at line 849 of file FGInitialCondition.cpp.

◆ SetHeadWindKtsIC()

void JSBSim::FGInitialCondition::SetHeadWindKtsIC ( double head )

Sets the initial headwind velocity.

Parameters

head	Initial headwind speed in knots

Definition at line 550 of file FGInitialCondition.cpp.

◆ SetLatitudeDegIC()

void JSBSim::FGInitialCondition::SetLatitudeDegIC ( double lat )

inline

Sets the initial latitude.

Parameters

lat	Initial latitude in degrees

Definition at line 302 of file FGInitialCondition.h.

◆ SetLatitudeRadIC()

void JSBSim::FGInitialCondition::SetLatitudeRadIC ( double lat )

Sets the initial latitude.

Parameters

lat	Initial latitude in radians

Definition at line 875 of file FGInitialCondition.cpp.

◆ SetLongitudeDegIC()

void JSBSim::FGInitialCondition::SetLongitudeDegIC ( double lon )

inline

Sets the initial longitude.

Parameters

lon	Initial longitude in degrees

Definition at line 313 of file FGInitialCondition.h.

◆ SetLongitudeRadIC()

void JSBSim::FGInitialCondition::SetLongitudeRadIC ( double lon )

Sets the initial longitude.

Parameters

lon	Initial longitude in radians

Definition at line 897 of file FGInitialCondition.cpp.

◆ SetMachIC()

void JSBSim::FGInitialCondition::SetMachIC ( double mach )

Set mach initial condition.

Parameters

mach	Mach number

Definition at line 163 of file FGInitialCondition.cpp.

◆ SetPhiDegIC()

void JSBSim::FGInitialCondition::SetPhiDegIC ( double phi )

inline

Sets the roll angle initial condition in degrees.

Parameters

phi	roll angle in degrees

Definition at line 273 of file FGInitialCondition.h.

◆ SetPhiRadIC()

void JSBSim::FGInitialCondition::SetPhiRadIC ( double phi )

inline

Sets the initial roll angle.

Parameters

phi	Initial roll angle in radians

Definition at line 587 of file FGInitialCondition.h.

◆ SetPRadpsIC()

void JSBSim::FGInitialCondition::SetPRadpsIC ( double P )

inline

Sets the initial body axis roll rate.

Parameters

P	Initial roll rate in radians/second

Definition at line 428 of file FGInitialCondition.h.

◆ SetPsiDegIC()

void JSBSim::FGInitialCondition::SetPsiDegIC ( double psi )

inline

Sets the heading angle initial condition in degrees.

Parameters

psi	Heading angle in degrees

Definition at line 277 of file FGInitialCondition.h.

◆ SetPsiRadIC()

void JSBSim::FGInitialCondition::SetPsiRadIC ( double psi )

inline

Sets the initial heading angle.

Parameters

psi	Initial heading angle in radians

Definition at line 595 of file FGInitialCondition.h.

◆ SetQRadpsIC()

void JSBSim::FGInitialCondition::SetQRadpsIC ( double Q )

inline

Sets the initial body axis pitch rate.

Parameters

Q	Initial pitch rate in radians/second

Definition at line 432 of file FGInitialCondition.h.

◆ SetRRadpsIC()

void JSBSim::FGInitialCondition::SetRRadpsIC ( double R )

inline

Sets the initial body axis yaw rate.

Parameters

R	initial yaw rate in radians/second

Definition at line 436 of file FGInitialCondition.h.

◆ SetTargetNlfIC()

void JSBSim::FGInitialCondition::SetTargetNlfIC ( double nlf )

inline

Sets the target normal load factor.

Parameters

nlf	Normal load factor

Definition at line 613 of file FGInitialCondition.h.

◆ SetTerrainElevationFtIC()

void JSBSim::FGInitialCondition::SetTerrainElevationFtIC ( double elev )

Sets the initial terrain elevation.

Parameters

elev	Initial terrain elevation in feet

Definition at line 638 of file FGInitialCondition.cpp.

◆ SetThetaDegIC()

void JSBSim::FGInitialCondition::SetThetaDegIC ( double theta )

inline

Sets pitch angle initial condition in degrees.

Parameters

theta Theta (pitch) angle in degrees

Definition at line 262 of file FGInitialCondition.h.

◆ SetThetaRadIC()

void JSBSim::FGInitialCondition::SetThetaRadIC ( double theta )

inline

Sets the initial pitch angle.

Parameters

theta Initial pitch angle in radians

Definition at line 591 of file FGInitialCondition.h.

◆ SetUBodyFpsIC()

void JSBSim::FGInitialCondition::SetUBodyFpsIC ( double ubody )

inline

Sets the initial body axis X velocity.

Parameters

ubody Initial X velocity in feet/second

Definition at line 404 of file FGInitialCondition.h.

◆ SetVBodyFpsIC()

void JSBSim::FGInitialCondition::SetVBodyFpsIC ( double vbody )

inline

Sets the initial body axis Y velocity.

Parameters

vbody Initial Y velocity in feet/second

Definition at line 408 of file FGInitialCondition.h.

◆ SetVcalibratedKtsIC()

void JSBSim::FGInitialCondition::SetVcalibratedKtsIC ( double vc )

Set calibrated airspeed initial condition in knots.

Parameters

vc	Calibrated airspeed in knots

Definition at line 173 of file FGInitialCondition.cpp.

◆ SetVDownFpsIC()

void JSBSim::FGInitialCondition::SetVDownFpsIC ( double vd )

inline

Sets the initial local axis down velocity.

Parameters

vd	Initial down velocity in feet/second

Definition at line 424 of file FGInitialCondition.h.

◆ SetVEastFpsIC()

void JSBSim::FGInitialCondition::SetVEastFpsIC ( double ve )

inline

Sets the initial local axis east velocity.

Parameters

ve	Initial east velocity in feet/second

Definition at line 420 of file FGInitialCondition.h.

◆ SetVequivalentKtsIC()

void JSBSim::FGInitialCondition::SetVequivalentKtsIC ( double ve )

Set equivalent airspeed initial condition in knots.

Parameters

ve	Equivalent airspeed in knots

Definition at line 152 of file FGInitialCondition.cpp.

◆ SetVgroundFpsIC()

void JSBSim::FGInitialCondition::SetVgroundFpsIC ( double vg )

Sets the initial ground speed.

Parameters

vg	Initial ground speed in feet/second

Definition at line 235 of file FGInitialCondition.cpp.

◆ SetVgroundKtsIC()

void JSBSim::FGInitialCondition::SetVgroundKtsIC ( double vg )

inline

Set ground speed initial condition in knots.

Parameters

vg	Ground speed in knots

Definition at line 246 of file FGInitialCondition.h.

◆ SetVNorthFpsIC()

void JSBSim::FGInitialCondition::SetVNorthFpsIC ( double vn )

inline

Sets the initial local axis north velocity.

Parameters

vn	Initial north velocity in feet/second

Definition at line 416 of file FGInitialCondition.h.

◆ SetVtrueFpsIC()

void JSBSim::FGInitialCondition::SetVtrueFpsIC ( double vt )

Sets the initial true airspeed.

Parameters

vt	Initial true airspeed in feet/second

Definition at line 259 of file FGInitialCondition.cpp.

◆ SetVtrueKtsIC()

void JSBSim::FGInitialCondition::SetVtrueKtsIC ( double vtrue )

inline

Set true airspeed initial condition in knots.

Parameters

vtrue True airspeed in knots

Definition at line 242 of file FGInitialCondition.h.

◆ SetWBodyFpsIC()

void JSBSim::FGInitialCondition::SetWBodyFpsIC ( double wbody )

inline

Sets the initial body axis Z velocity.

Parameters

wbody Initial Z velocity in feet/second

Definition at line 412 of file FGInitialCondition.h.

◆ SetWindDirDegIC()

void JSBSim::FGInitialCondition::SetWindDirDegIC ( double dir )

Sets the initial wind direction.

Parameters

dir	Initial direction wind is coming from in degrees

Definition at line 620 of file FGInitialCondition.cpp.

◆ SetWindDownKtsIC()

void JSBSim::FGInitialCondition::SetWindDownKtsIC ( double wD )

Sets the initial wind downward speed.

Parameters

wD	Initial downward wind speed in knots

Definition at line 578 of file FGInitialCondition.cpp.

◆ SetWindMagKtsIC()

void JSBSim::FGInitialCondition::SetWindMagKtsIC ( double mag )

Sets the initial total wind speed.

Parameters

mag	Initial wind velocity magnitude in knots

Definition at line 594 of file FGInitialCondition.cpp.

◆ SetWindNEDFpsIC()

void JSBSim::FGInitialCondition::SetWindNEDFpsIC	(	double	wN,
		double	wE,
		double	wD )

Sets the initial wind velocity.

Parameters

wN	Initial wind velocity in local north direction, feet/second
wE	Initial wind velocity in local east direction, feet/second
wD	Initial wind velocity in local down direction, feet/second

Definition at line 514 of file FGInitialCondition.cpp.

◆ TrimRequested()

int JSBSim::FGInitialCondition::TrimRequested ( void ) const

inline

Does initialization file call for trim ?

Returns: Trim type, if any requested (version 1).

Definition at line 683 of file FGInitialCondition.h.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FGInitialCondition()

◆ ~FGInitialCondition()

Member Function Documentation

◆ bind()

◆ GetAlphaDegIC()

◆ GetAlphaRadIC()

◆ GetAltitudeAGLFtIC()

◆ GetAltitudeASLFtIC()

◆ GetBetaDegIC()

◆ GetBetaRadIC()

◆ GetClimbRateFpmIC()

◆ GetClimbRateFpsIC()

◆ GetEarthPositionAngleIC()

◆ GetFlightPathAngleDegIC()

◆ GetFlightPathAngleRadIC()

◆ GetGeodLatitudeDegIC()

◆ GetGeodLatitudeRadIC()

◆ GetLatitudeDegIC()

◆ GetLatitudeRadIC()

◆ GetLongitudeDegIC()

◆ GetLongitudeRadIC()

◆ GetMachIC()

◆ GetOrientation()

◆ GetPhiDegIC()

◆ GetPhiRadIC()

◆ GetPosition()

◆ GetPQRRadpsIC()

◆ GetPRadpsIC()

◆ GetPsiDegIC()

◆ GetPsiRadIC()

◆ GetQRadpsIC()

◆ GetRRadpsIC()

◆ GetSpeedSet()

◆ GetTargetNlfIC()

◆ GetTerrainElevationFtIC()

◆ GetThetaDegIC()

◆ GetThetaRadIC()

◆ GetUBodyFpsIC()

◆ GetUVWFpsIC()

◆ GetVBodyFpsIC()

◆ GetVcalibratedKtsIC()

◆ GetVDownFpsIC()

◆ GetVEastFpsIC()

◆ GetVequivalentKtsIC()

◆ GetVgroundFpsIC()

◆ GetVgroundKtsIC()

◆ GetVNorthFpsIC()

◆ GetVtrueFpsIC()

◆ GetVtrueKtsIC()

◆ GetWBodyFpsIC()

◆ GetWindDFpsIC()

◆ GetWindDirDegIC()

◆ GetWindEFpsIC()

◆ GetWindFpsIC()

◆ GetWindNEDFpsIC()

◆ GetWindNFpsIC()

◆ GetWindUFpsIC()

◆ GetWindVFpsIC()

◆ GetWindWFpsIC()

◆ InitializeIC()

◆ IsEngineRunning()

◆ Load()

◆ ResetIC()

◆ SetAlphaDegIC()

◆ SetAlphaRadIC()

◆ SetAltitudeAGLFtIC()

◆ SetAltitudeASLFtIC()

◆ SetBetaDegIC()

◆ SetBetaRadIC()

◆ SetClimbRateFpmIC()

◆ SetClimbRateFpsIC()

◆ SetCrossWindKtsIC()

◆ SetFlightPathAngleDegIC()

◆ SetFlightPathAngleRadIC()

◆ SetGeodLatitudeDegIC()

◆ SetGeodLatitudeRadIC()