FlightGear next
JSBSim::FGSensor Class Reference

Encapsulates a Sensor component for the flight control system. More...

#include <FGSensor.h>

Inherits JSBSim::FGFCSComponent.

Inherited by JSBSim::FGAccelerometer, JSBSim::FGGyro, and JSBSim::FGMagnetometer.

Public Member Functions

 FGSensor (FGFCS *fcs, Element *element)
 
virtual ~FGSensor ()
 
void SetFailLow (double val)
 
void SetFailHigh (double val)
 
void SetFailStuck (double val)
 
double GetFailLow (void) const
 
double GetFailHigh (void) const
 
double GetFailStuck (void) const
 
int GetQuantized (void) const
 
bool Run (void) override
 
void ResetPastStates (void) override
 
- Public Member Functions inherited from JSBSim::FGFCSComponent
 FGFCSComponent (FGFCS *fcs, Element *el)
 Constructor.
 
virtual ~FGFCSComponent ()
 Destructor.
 
virtual void SetOutput (void)
 
double GetOutput (void) const
 
std::string GetName (void) const
 
std::string GetType (void) const
 
virtual double GetOutputPct (void) const
 
- 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.
 
MessageProcessNextMessage (void)
 Reads the next message on the queue and removes it from the queue.
 
void disableHighLighting (void)
 Disables highlighting in the console output.
 

Protected Types

enum  eNoiseType { ePercent =0 , eAbsolute }
 
enum  eDistributionType { eUniform =0 , eGaussian }
 

Protected Member Functions

void ProcessSensorSignal (void)
 
void Noise (void)
 
void Bias (void)
 
void Drift (void)
 
void Quantize (void)
 
void Lag (void)
 
void Gain (void)
 
void bind (Element *el) override
 
- Protected Member Functions inherited from JSBSim::FGFCSComponent
void Delay (void)
 
void Clip (void)
 
void CheckInputNodes (size_t MinNodes, size_t MaxNodes, Element *el)
 

Protected Attributes

enum JSBSim::FGSensor::eNoiseType NoiseType
 
enum JSBSim::FGSensor::eDistributionType DistributionType
 
double min
 
double max
 
double span
 
double bias
 
double gain
 
double drift_rate
 
double drift
 
double noise_variance
 
double lag
 
double granularity
 
double ca
 
double cb
 lag filter coefficient "a"
 
double PreviousOutput
 lag filter coefficient "b"
 
double PreviousInput
 
int noise_type
 
int bits
 
int quantized
 
int divisions
 
bool fail_low
 
bool fail_high
 
bool fail_stuck
 
std::string quant_property
 
- Protected Attributes inherited from JSBSim::FGFCSComponent
FGFCSfcs
 
FGPropertyManagerPropertyManager
 
std::vector< FGPropertyNode_ptrOutputNodes
 
FGParameter_ptr ClipMin
 
FGParameter_ptr ClipMax
 
std::vector< FGPropertyValue_ptrInitNodes
 
std::vector< FGPropertyValue_ptrInputNodes
 
std::vector< double > output_array
 
std::string Type
 
std::string Name
 
double Input
 
double Output
 
double delay_time
 
unsigned int delay
 
int index
 
double dt
 
bool clip
 
bool cyclic_clip
 

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< MessageMessages
 
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/(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__
 
static int gaussian_random_number_phase = 0
 

Detailed Description

Encapsulates a Sensor component for the flight control system.

Syntax:

<sensor name="name">
<input> property </input>
<lag> number </lag>
<noise [variation="PERCENT|ABSOLUTE"] [distribution="UNIFORM|GAUSSIAN"]> number </noise>
<quantization name="name">
<bits> number </bits>
<min> number </min>
<max> number </max>
</quantization>
<drift_rate> number </drift_rate>
<gain> number </gain>
<bias> number </bias>
<delay [type="time|frames"]> number < /delay>
</sensor>
double drift_rate
Definition FGSensor.h:152
const char * name

Example:

<sensor name="aero/sensor/qbar">
<input> aero/qbar </input>
<lag> 0.5 </lag>
<noise variation="PERCENT"> 2 </noise>
<quantization name="aero/sensor/quantized/qbar">
<bits> 12 </bits>
<min> 0 </min>
<max> 400 </max>
</quantization>
<bias> 0.5 </bias>
</sensor>

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.

Author
Jon S. Berndt
Version
Revision
1.24

Definition at line 127 of file FGSensor.h.

Member Enumeration Documentation

◆ eDistributionType

Enumerator
eUniform 
eGaussian 

Definition at line 147 of file FGSensor.h.

◆ eNoiseType

Enumerator
ePercent 
eAbsolute 

Definition at line 146 of file FGSensor.h.

Constructor & Destructor Documentation

◆ FGSensor()

JSBSim::FGSensor::FGSensor ( FGFCS * fcs,
Element * element )

Definition at line 52 of file FGSensor.cpp.

◆ ~FGSensor()

JSBSim::FGSensor::~FGSensor ( )
virtual

Definition at line 125 of file FGSensor.cpp.

Member Function Documentation

◆ Bias()

void JSBSim::FGSensor::Bias ( void )
protected

Definition at line 203 of file FGSensor.cpp.

◆ bind()

void JSBSim::FGSensor::bind ( Element * el)
overrideprotectedvirtual

Reimplemented from JSBSim::FGFCSComponent.

Definition at line 247 of file FGSensor.cpp.

◆ Drift()

void JSBSim::FGSensor::Drift ( void )
protected

Definition at line 217 of file FGSensor.cpp.

◆ Gain()

void JSBSim::FGSensor::Gain ( void )
protected

Definition at line 210 of file FGSensor.cpp.

◆ GetFailHigh()

double JSBSim::FGSensor::GetFailHigh ( void ) const
inline

Definition at line 138 of file FGSensor.h.

◆ GetFailLow()

double JSBSim::FGSensor::GetFailLow ( void ) const
inline

Definition at line 137 of file FGSensor.h.

◆ GetFailStuck()

double JSBSim::FGSensor::GetFailStuck ( void ) const
inline

Definition at line 139 of file FGSensor.h.

◆ GetQuantized()

int JSBSim::FGSensor::GetQuantized ( void ) const
inline

Definition at line 140 of file FGSensor.h.

◆ Lag()

void JSBSim::FGSensor::Lag ( void )
protected

Definition at line 236 of file FGSensor.cpp.

◆ Noise()

void JSBSim::FGSensor::Noise ( void )
protected

Definition at line 180 of file FGSensor.cpp.

◆ ProcessSensorSignal()

void JSBSim::FGSensor::ProcessSensorSignal ( void )
protected

Definition at line 154 of file FGSensor.cpp.

◆ Quantize()

void JSBSim::FGSensor::Quantize ( void )
protected

Definition at line 225 of file FGSensor.cpp.

◆ ResetPastStates()

void JSBSim::FGSensor::ResetPastStates ( void )
overridevirtual

Reimplemented from JSBSim::FGFCSComponent.

Definition at line 132 of file FGSensor.cpp.

◆ Run()

bool JSBSim::FGSensor::Run ( void )
overridevirtual

Reimplemented from JSBSim::FGFCSComponent.

Definition at line 141 of file FGSensor.cpp.

◆ SetFailHigh()

void JSBSim::FGSensor::SetFailHigh ( double val)
inline

Definition at line 134 of file FGSensor.h.

◆ SetFailLow()

void JSBSim::FGSensor::SetFailLow ( double val)
inline

Definition at line 133 of file FGSensor.h.

◆ SetFailStuck()

void JSBSim::FGSensor::SetFailStuck ( double val)
inline

Definition at line 135 of file FGSensor.h.

Member Data Documentation

◆ bias

double JSBSim::FGSensor::bias
protected

Definition at line 150 of file FGSensor.h.

◆ bits

int JSBSim::FGSensor::bits
protected

Definition at line 162 of file FGSensor.h.

◆ ca

double JSBSim::FGSensor::ca
protected

Definition at line 157 of file FGSensor.h.

◆ cb

double JSBSim::FGSensor::cb
protected

lag filter coefficient "a"

Definition at line 158 of file FGSensor.h.

◆ DistributionType

enum JSBSim::FGSensor::eDistributionType JSBSim::FGSensor::DistributionType
protected

◆ divisions

int JSBSim::FGSensor::divisions
protected

Definition at line 164 of file FGSensor.h.

◆ drift

double JSBSim::FGSensor::drift
protected

Definition at line 153 of file FGSensor.h.

◆ drift_rate

double JSBSim::FGSensor::drift_rate
protected

Definition at line 152 of file FGSensor.h.

◆ fail_high

bool JSBSim::FGSensor::fail_high
protected

Definition at line 166 of file FGSensor.h.

◆ fail_low

bool JSBSim::FGSensor::fail_low
protected

Definition at line 165 of file FGSensor.h.

◆ fail_stuck

bool JSBSim::FGSensor::fail_stuck
protected

Definition at line 167 of file FGSensor.h.

◆ gain

double JSBSim::FGSensor::gain
protected

Definition at line 151 of file FGSensor.h.

◆ granularity

double JSBSim::FGSensor::granularity
protected

Definition at line 156 of file FGSensor.h.

◆ lag

double JSBSim::FGSensor::lag
protected

Definition at line 155 of file FGSensor.h.

◆ max

double JSBSim::FGSensor::max
protected

Definition at line 148 of file FGSensor.h.

◆ min

double JSBSim::FGSensor::min
protected

Definition at line 148 of file FGSensor.h.

◆ noise_type

int JSBSim::FGSensor::noise_type
protected

Definition at line 161 of file FGSensor.h.

◆ noise_variance

double JSBSim::FGSensor::noise_variance
protected

Definition at line 154 of file FGSensor.h.

◆ NoiseType

enum JSBSim::FGSensor::eNoiseType JSBSim::FGSensor::NoiseType
protected

◆ PreviousInput

double JSBSim::FGSensor::PreviousInput
protected

Definition at line 160 of file FGSensor.h.

◆ PreviousOutput

double JSBSim::FGSensor::PreviousOutput
protected

lag filter coefficient "b"

Definition at line 159 of file FGSensor.h.

◆ quant_property

std::string JSBSim::FGSensor::quant_property
protected

Definition at line 168 of file FGSensor.h.

◆ quantized

int JSBSim::FGSensor::quantized
protected

Definition at line 163 of file FGSensor.h.

◆ span

double JSBSim::FGSensor::span
protected

Definition at line 149 of file FGSensor.h.


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