![]() |
JSBSim Flight Dynamics Model 1.2.3 (07 Jun 2025)
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.
If a noise element is specified, then a property will be created, named name/randomseed if the name contains a path separator '/' or fcs/name/randomseed if the name does not contain a path separator. Which allows a user to specify a random seed to be used for the noise generation.
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 133 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 | GetNoiseRandomSeed (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) |
void | SetNoiseRandomSeed (int seed) |
![]() | |
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) |
![]() | |
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) |
![]() | |
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 |
![]() | |
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< SGPropertyNode_ptr > | OutputNodes |
std::string | Type |
Additional Inherited Members | |
![]() | |
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 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 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 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. | |
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__ |
|
protected |
Definition at line 156 of file FGSensor.h.
|
protected |
Definition at line 155 of file FGSensor.h.
Definition at line 53 of file FGSensor.cpp.
|
virtual |
Definition at line 127 of file FGSensor.cpp.
|
protected |
Definition at line 204 of file FGSensor.cpp.
|
overrideprotectedvirtual |
Reimplemented from FGFCSComponent.
Definition at line 248 of file FGSensor.cpp.
|
protected |
Definition at line 218 of file FGSensor.cpp.
|
protected |
Definition at line 211 of file FGSensor.cpp.
|
inline |
Definition at line 144 of file FGSensor.h.
|
inline |
Definition at line 143 of file FGSensor.h.
|
inline |
Definition at line 145 of file FGSensor.h.
int GetNoiseRandomSeed | ( | void | ) | const |
Definition at line 292 of file FGSensor.cpp.
|
inline |
Definition at line 146 of file FGSensor.h.
|
protected |
Definition at line 237 of file FGSensor.cpp.
|
protected |
Definition at line 182 of file FGSensor.cpp.
|
protected |
Definition at line 156 of file FGSensor.cpp.
|
protected |
Definition at line 226 of file FGSensor.cpp.
|
overridevirtual |
Reimplemented from FGFCSComponent.
Definition at line 134 of file FGSensor.cpp.
|
overridevirtual |
Reimplemented from FGFCSComponent.
Definition at line 143 of file FGSensor.cpp.
|
inline |
Definition at line 140 of file FGSensor.h.
|
inline |
Definition at line 139 of file FGSensor.h.
|
inline |
Definition at line 141 of file FGSensor.h.
void SetNoiseRandomSeed | ( | int | seed | ) |
Definition at line 286 of file FGSensor.cpp.
|
protected |
Definition at line 159 of file FGSensor.h.
|
protected |
Definition at line 171 of file FGSensor.h.
|
protected |
Definition at line 166 of file FGSensor.h.
|
protected |
lag filter coefficient "a"
Definition at line 167 of file FGSensor.h.
|
protected |
Definition at line 173 of file FGSensor.h.
|
protected |
Definition at line 162 of file FGSensor.h.
|
protected |
Definition at line 161 of file FGSensor.h.
|
protected |
Definition at line 175 of file FGSensor.h.
|
protected |
Definition at line 174 of file FGSensor.h.
|
protected |
Definition at line 176 of file FGSensor.h.
|
protected |
Definition at line 160 of file FGSensor.h.
|
protected |
Definition at line 165 of file FGSensor.h.
|
protected |
Definition at line 164 of file FGSensor.h.
|
protected |
Definition at line 157 of file FGSensor.h.
|
protected |
Definition at line 157 of file FGSensor.h.
|
protected |
Definition at line 170 of file FGSensor.h.
|
protected |
Definition at line 163 of file FGSensor.h.
|
protected |
Definition at line 169 of file FGSensor.h.
|
protected |
lag filter coefficient "b"
Definition at line 168 of file FGSensor.h.
|
protected |
Definition at line 177 of file FGSensor.h.
|
protected |
Definition at line 172 of file FGSensor.h.
|
protected |
Definition at line 158 of file FGSensor.h.