JSBSim Flight Dynamics Model  1.2.0 (05 Nov 2023)
An Open Source Flight Dynamics and Control Software Library in C++
FGGyro Class Reference

Detailed Description

Encapsulates a Gyro component for the flight control system.

Syntax:

<gyro name="name">
<lag> number </lag>
<noise variation="PERCENT|ABSOLUTE"> number </noise>
<quantization name="name">
<bits> number </bits>
<min> number </min>
<max> number </max>
</quantization>
<drift_rate> number </drift_rate>
<bias> number </bias>
</gyro>

Example:

<gyro name="aero/gyro/roll">
<axis> X </axis>
<lag> 0.5 </lag>
<noise variation="PERCENT"> 2 </noise>
<quantization name="aero/gyro/quantized/qbar">
<bits> 12 </bits>
<min> 0 </min>
<max> 400 </max>
</quantization>
<bias> 0.5 </bias>
</gyro>

For noise, if the type is PERCENT, then the value supplied is understood to be a percentage variance. That is, if the number given is 0.05, the the variance is understood to be +/-0.05 percent maximum variance. So, the actual value for the gyro will be anywhere from 0.95 to 1.05 of the actual "perfect" value at any time - even varying all the way from 0.95 to 1.05 in adjacent frames - whatever the delta time.

Author
Jon S. Berndt
Version
Revision
1.7

Definition at line 107 of file FGGyro.h.

#include <FGGyro.h>

+ Inheritance diagram for FGGyro:
+ Collaboration diagram for FGGyro:

Public Member Functions

 FGGyro (FGFCS *fcs, Element *element)
 
bool Run (void) override
 
- Public Member Functions inherited from FGSensor
 FGSensor (FGFCS *fcs, Element *element)
 
double GetFailHigh (void) const
 
double GetFailLow (void) const
 
double GetFailStuck (void) const
 
int GetQuantized (void) const
 
void ResetPastStates (void) override
 
bool Run (void) override
 
void SetFailHigh (double val)
 
void SetFailLow (double val)
 
void SetFailStuck (double val)
 
- Public Member Functions inherited from FGFCSComponent
 FGFCSComponent (FGFCS *fcs, Element *el)
 Constructor.
 
virtual ~FGFCSComponent ()
 Destructor.
 
std::string GetName (void) const
 
double GetOutput (void) const
 
virtual double GetOutputPct (void) const
 
std::string GetType (void) const
 
virtual void SetOutput (void)
 
- Public Member Functions inherited from FGJSBBase
 FGJSBBase ()
 Constructor for FGJSBBase.
 
virtual ~FGJSBBase ()
 Destructor for FGJSBBase.
 
void disableHighLighting (void)
 Disables highlighting in the console output.
 
- Public Member Functions inherited from FGSensorOrientation
 FGSensorOrientation (Element *element)
 

Additional Inherited Members

- Public Types inherited from FGJSBBase
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.
 
- Static Public Member Functions inherited from FGJSBBase
static const std::string & GetVersion (void)
 Returns the version number of JSBSim. More...
 
static constexpr double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit. More...
 
static constexpr double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine. More...
 
static constexpr double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius. More...
 
static constexpr double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine. More...
 
static constexpr double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin. More...
 
static constexpr double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius. More...
 
static constexpr double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit. More...
 
static constexpr double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin. More...
 
static constexpr double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius. More...
 
static constexpr double FeetToMeters (double measure)
 Converts from feet to meters. More...
 
static bool EqualToRoundoff (double a, double b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (float a, float b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (float a, double b)
 Finite precision comparison. More...
 
static bool EqualToRoundoff (double a, float b)
 Finite precision comparison. More...
 
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 Public Attributes inherited from 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
 
- Protected Types inherited from FGSensor
enum  eDistributionType { eUniform =0 , eGaussian }
 
enum  eNoiseType { ePercent =0 , eAbsolute }
 
- Protected Member Functions inherited from FGSensor
void Bias (void)
 
void bind (Element *el, FGPropertyManager *pm) override
 
void Drift (void)
 
void Gain (void)
 
void Lag (void)
 
void Noise (void)
 
void ProcessSensorSignal (void)
 
void Quantize (void)
 
- Protected Member Functions inherited from FGFCSComponent
void CheckInputNodes (size_t MinNodes, size_t MaxNodes, Element *el)
 
void Clip (void)
 
void Delay (void)
 
- Protected Member Functions inherited from FGSensorOrientation
void CalculateTransformMatrix (void)
 
- Static Protected Member Functions inherited from FGJSBBase
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- Protected Attributes inherited from FGSensor
double bias
 
int bits
 
double ca
 
double cb
 lag filter coefficient "a"
 
enum JSBSim::FGSensor::eDistributionType DistributionType
 
int divisions
 
double drift
 
double drift_rate
 
bool fail_high
 
bool fail_low
 
bool fail_stuck
 
double gain
 
double granularity
 
double lag
 
double max
 
double min
 
int noise_type
 
double noise_variance
 
enum JSBSim::FGSensor::eNoiseType NoiseType
 
double PreviousInput
 
double PreviousOutput
 lag filter coefficient "b"
 
std::string quant_property
 
int quantized
 
double span
 
- Protected Attributes inherited from FGFCSComponent
bool clip
 
FGParameter_ptr ClipMax
 
FGParameter_ptr ClipMin
 
bool cyclic_clip
 
unsigned int delay
 
double delay_time
 
double dt
 
FGFCSfcs
 
int index
 
std::vector< FGPropertyValue_ptr > InitNodes
 
double Input
 
std::vector< FGPropertyValue_ptr > InputNodes
 
std::string Name
 
double Output
 
std::vector< double > output_array
 
std::vector< FGPropertyNode_ptr > OutputNodes
 
std::string Type
 
- Protected Attributes inherited from FGSensorOrientation
int axis
 
FGMatrix33 mT
 
FGColumnVector3 vOrient
 
- Static Protected Attributes inherited from FGJSBBase
static constexpr double radtodeg = 180. / M_PI
 
static constexpr double degtorad = M_PI / 180.
 
static constexpr double hptoftlbssec = 550.0
 
static constexpr double psftoinhg = 0.014138
 
static constexpr double psftopa = 47.88
 
static constexpr double fttom = 0.3048
 
static constexpr double ktstofps = 1852./(3600*fttom)
 
static constexpr double fpstokts = 1.0 / ktstofps
 
static constexpr double inchtoft = 1.0/12.0
 
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. More...
 
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__
 

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