FGJSBBase Class Reference

#include <FGJSBBase.h>

Inherited by FGBallonet, FGColumnVector3, FGCondition, FGEngine, FGFCSComponent, FGFDMExec, FGfdmSocket, FGForce, FGGroundCallback, FGInitialCondition, FGLGear, FGLocation [private, virtual], FGMatrix33, FGModel, FGParameter, FGPropertyManager, FGQuaternion [private, virtual], FGScript, FGState, FGTank, FGTrim, FGTrimAnalysis, FGTrimAnalysisControl, FGTrimAxis, and MatrixException.

List of all members.


Detailed Description

This class provides universal constants, utility functions, messaging functions, and enumerated constants to JSBSim.
Author:
Jon S. Berndt
Version:
Id
FGJSBBase.h,v 1.23 2009/05/26 05:35:42 jberndt Exp

Definition at line 86 of file FGJSBBase.h.


Public Types

enum  { eL = 1, eM, eN }
 Moments L, M, N.
enum  { eP = 1, eQ, eR }
 Rates P, Q, R.
enum  { eU = 1, eV, eW }
 Velocities U, V, W.
enum  { eX = 1, eY, eZ }
 Positions X, Y, Z.
enum  { ePhi = 1, eTht, ePsi }
 Euler angles Phi, Theta, Psi.
enum  { eDrag = 1, eSide, eLift }
 Stability axis forces, Drag, Side force, Lift.
enum  { eRoll = 1, ePitch, eYaw }
 Local frame orientation Roll, Pitch, Yaw.
enum  { eNorth = 1, eEast, eDown }
 Local frame position North, East, Down.
enum  { eLat = 1, eLong, eRad }
 Locations Radius, Latitude, Longitude.
enum  {
  inNone = 0, inDegrees, inRadians, inMeters,
  inFeet
}
 Conversion specifiers.

Public Member Functions

void disableHighLighting (void)
 Disables highlighting in the console output.
 FGJSBBase ()
 Constructor for FGJSBBase.
string GetVersion (void)
 Returns the version number of JSBSim.
 ~FGJSBBase ()
 Destructor for FGJSBBase.
JSBSim Messaging functions
MessageProcessMessage (void)
 Reads the message on the queue and removes it from the queue.
void PutMessage (const string &text, double dVal)
 Creates a message with the given text and double value and places it on the queue.
void PutMessage (const string &text, int iVal)
 Creates a message with the given text and integer value and places it on the queue.
void PutMessage (const string &text, bool bVal)
 Creates a message with the given text and boolean value and places it on the queue.
void PutMessage (const string &text)
 Creates a message with the given text and places it on the queue.
void PutMessage (const Message &msg)
 Places a Message structure on the Message queue.
int SomeMessages (void)
 Reads the message on the queue (but does not delete it).

Static Public Member Functions

static double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit.
static double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin.
static double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine.
static double Constrain (double min, double value, double max)
 Constrain a value between a minimum and a maximum value.
static bool EqualToRoundoff (double a, float b)
 Finite precision comparison.
static bool EqualToRoundoff (float a, double b)
 Finite precision comparison.
static bool EqualToRoundoff (float a, float b)
 Finite precision comparison.
static bool EqualToRoundoff (double a, double b)
 Finite precision comparison.
static double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius.
static double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius.
static double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit.
static double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine.
static double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius.
static double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin.
static double sign (double num)

Static Public Attributes

static short debug_lvl = 1
JSBSim console output highlighting terms.
static char fgblue [6] = {27, '[', '3', '4', 'm', '\0' }
 blue text
static char fgcyan [6] = {27, '[', '3', '6', 'm', '\0' }
 cyan text
static char fgdef [6] = {27, '[', '3', '9', 'm', '\0' }
 default text
static char fggreen [6] = {27, '[', '3', '2', 'm', '\0' }
 green text
static char fgred [6] = {27, '[', '3', '1', 'm', '\0' }
 red text
static char halfint [5] = {27, '[', '2', 'm', '\0' }
 low intensity text
static char highint [5] = {27, '[', '1', 'm', '\0' }
 highlights 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 underoff [6] = {27, '[', '2', '4', 'm', '\0' }
 underline off
static char underon [5] = {27, '[', '4', 'm', '\0' }
 underlines text

Protected Member Functions

void Debug (int from)

Static Protected Member Functions

static string CreateIndexedPropertyName (string Property, int index)
static double GaussianRandomNumber (void)

Static Protected Attributes

static const double degtorad = 1.745329E-2
static const double fpstokts = 0.592484
static const double fttom = 0.3048
static const double hptoftlbssec = 550.0
static const double in3tom3 = 1.638706E-5
static const double inchtoft = 0.08333333
static const double inhgtopa = 3386.38
static const string JSBSim_version = "1.0 "__DATE__" "__TIME__
static const double kgtolb = 2.20462
static const double kgtoslug = 0.06852168
static const double ktstofps = 1.68781
static const double lbtoslug = 1.0/slugtolb
static Message localMsg
static const double m3toft3 = 1.0/(fttom*fttom*fttom)
static unsigned int messageId = 0
static std::queue< MessageMessages
static const string needed_cfg_version = "2.0"
static const double psftoinhg = 0.014138
static const double psftopa = 47.88
static const double radtodeg = 57.29578
static double Reng = 1716.0
static const double SHRatio = 1.40
static const double slugtolb = 32.174049

Classes

class  Filter
 First order, (low pass / lag) filter. More...
class  Message
 JSBSim Message structure. More...

Member Function Documentation

static double CelsiusToFahrenheit ( double  celsius  )  [inline, static]

Parameters:
celsius The temperature in degrees Celsius.
Returns:
The temperature in Fahrenheit.

Definition at line 241 of file FGJSBBase.h.

static double CelsiusToKelvin ( double  celsius  )  [inline, static]

Parameters:
celsius The temperature in degrees Celsius.
Returns:
The temperature in Kelvin.

Definition at line 248 of file FGJSBBase.h.

static double CelsiusToRankine ( double  celsius  )  [inline, static]

Parameters:
celsius The temperature in degrees Celsius.
Returns:
The temperature in Rankine.

Definition at line 206 of file FGJSBBase.h.

static bool EqualToRoundoff ( double  a,
float  b 
) [inline, static]

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 289 of file FGJSBBase.h.

static bool EqualToRoundoff ( float  a,
double  b 
) [inline, static]

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 281 of file FGJSBBase.h.

static bool EqualToRoundoff ( float  a,
float  b 
) [inline, static]

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 272 of file FGJSBBase.h.

static bool EqualToRoundoff ( double  a,
double  b 
) [inline, static]

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 263 of file FGJSBBase.h.

static double FahrenheitToCelsius ( double  fahrenheit  )  [inline, static]

Parameters:
fahrenheit The temperature in degrees Fahrenheit.
Returns:
The temperature in Celsius.

Definition at line 234 of file FGJSBBase.h.

string GetVersion ( void   )  [inline]

Returns:
The version number of JSBSim.

Definition at line 189 of file FGJSBBase.h.

static double KelvinToCelsius ( double  kelvin  )  [inline, static]

Parameters:
celsius The temperature in degrees Kelvin.
Returns:
The temperature in Celsius.

Definition at line 255 of file FGJSBBase.h.

static double KelvinToFahrenheit ( double  kelvin  )  [inline, static]

Parameters:
kelvin The temperature in degrees Kelvin.
Returns:
The temperature in Fahrenheit.

Definition at line 199 of file FGJSBBase.h.

static double KelvinToRankine ( double  kelvin  )  [inline, static]

Parameters:
kelvin The temperature in degrees Kelvin.
Returns:
The temperature in Rankine.

Definition at line 220 of file FGJSBBase.h.

FGJSBBase::Message * ProcessMessage ( void   ) 

Returns:
pointer to a Message structure (or NULL if no mesage)

Definition at line 177 of file FGJSBBase.cpp.

void PutMessage ( const string &  text,
double  dVal 
)

Parameters:
text message text
dVal double value associated with the message
Returns:
pointer to a Message structure

Definition at line 157 of file FGJSBBase.cpp.

void PutMessage ( const string &  text,
int  iVal 
)

Parameters:
text message text
iVal integer value associated with the message
Returns:
pointer to a Message structure

Definition at line 144 of file FGJSBBase.cpp.

void PutMessage ( const string &  text,
bool  bVal 
)

Parameters:
text message text
bVal boolean value associated with the message
Returns:
pointer to a Message structure

Definition at line 131 of file FGJSBBase.cpp.

void PutMessage ( const string &  text  ) 

Parameters:
text message text
Returns:
pointer to a Message structure

Definition at line 119 of file FGJSBBase.cpp.

void PutMessage ( const Message msg  ) 

Parameters:
msg pointer to a Message structure
Returns:
pointer to a Message structure

Definition at line 112 of file FGJSBBase.cpp.

static double RankineToCelsius ( double  rankine  )  [inline, static]

Parameters:
rankine The temperature in degrees Rankine.
Returns:
The temperature in Celsius.

Definition at line 213 of file FGJSBBase.h.

static double RankineToKelvin ( double  rankine  )  [inline, static]

Parameters:
rankine The temperature in degrees Rankine.
Returns:
The temperature in Kelvin.

Definition at line 227 of file FGJSBBase.h.

int SomeMessages ( void   ) 

Returns:
1 if some messages

Definition at line 170 of file FGJSBBase.cpp.


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

Generated on Tue May 26 00:55:11 2009 for JSBSim Flight Dynamics Model by  doxygen 1.5.5