JSBSim Flight Dynamics Model
1.2.0 (05 Nov 2023)
An Open Source Flight Dynamics and Control Software Library in C++
|
Encapsulates a Sensor component for the flight control system.
Syntax:
Example:
The only required element in the sensor definition is the input element. In that case, no degradation would be modeled, and the output would simply be the input.
Noise can be Gaussian or uniform, and the noise can be applied as a factor (PERCENT) or additively (ABSOLUTE). The noise that can be applied at each frame of the simulation execution is calculated as a random factor times a noise value that is specified in the config file. When the noise distribution type is Gaussian, the random number can be between roughly -3 and +3 for a span of six sigma. When the distribution type is UNIFORM, the random value can be between -1.0 and +1.0. This random value is multiplied against the specified noise to arrive at a random noise value for the frame. If the noise type is PERCENT, then random noise value is added to one, and that sum is then multiplied against the input signal for the sensor. In this case, the specified noise value in the config file would be expected to actually be a percent value, such as 0.05 (for a 5% variance). If the noise type is ABSOLUTE, then the random noise value specified in the config file is understood to be an absolute value of noise to be added to the input signal instead of being added to 1.0 and having that sum be multiplied against the input signal as in the PERCENT type. For the ABSOLUTE noise case, the noise number specified in the config file could be any number.
If the type is ABSOLUTE, then the noise number times the random number is added to the input signal instead of being multiplied against it as with the PERCENT type of noise.
The delay element can specify a frame delay. The integer number provided is the number of frames to delay the output signal.
Definition at line 127 of file FGSensor.h.
#include <FGSensor.h>
Public Member Functions | |
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. | |
Protected Types | |
enum | eDistributionType { eUniform =0 , eGaussian } |
enum | eNoiseType { ePercent =0 , eAbsolute } |
Protected Member Functions | |
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 Attributes | |
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 |
FGFCS * | fcs |
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 |
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 |
Static Protected Member Functions inherited from FGJSBBase | |
static std::string | CreateIndexedPropertyName (const std::string &Property, int index) |
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__ |