FlightGear next
JSBSim::FGKinemat Class Reference

Encapsulates a kinematic (mechanical) component for the flight control system. More...

#include <FGKinemat.h>

Inherits JSBSim::FGFCSComponent.

Public Member Functions

 FGKinemat (FGFCS *fcs, Element *element)
 Constructor.
 
 ~FGKinemat ()
 Destructor.
 
double GetOutputPct () const override
 Kinematic component output value.
 
bool Run (void) override
 Run method, overrides FGModel::Run().
 
- 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 void ResetPastStates (void)
 
- 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.
 

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
 
- Protected Member Functions inherited from JSBSim::FGFCSComponent
void Delay (void)
 
void Clip (void)
 
void CheckInputNodes (size_t MinNodes, size_t MaxNodes, Element *el)
 
virtual void bind (Element *el)
 
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- 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
 
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 kinematic (mechanical) component for the flight control system.

This component models the action of a moving effector, such as an aerosurface or other mechanized entity such as a landing gear strut for the purpose of effecting vehicle control or configuration. The form of the component specification is:

<kinematic name="Gear Control">
<input> [-]property </input>
[<noscale/>]
<traverse>
<setting>
<position> number </position>
<time> number </time>
</setting>
...
</traverse>
[<clipto>
<min> {[-]property name | value} </min>
<max> {[-]property name | value} </max>
</clipto>]
[<gain> {property name | value} </gain>]
[<output> {property} </output>]
</kinematic>
#define min(X, Y)
const char * name

The detent is the position that the component takes, and the lag is the time it takes to get to that position from an adjacent setting. For example:

<kinematic name="Gear Control">
<input>gear/gear-cmd-norm</input>
<traverse>
<setting>
<position>0</position>
<time>0</time>
</setting>
<setting>
<position>1</position>
<time>5</time>
</setting>
</traverse>
<output>gear/gear-pos-norm</output>
</kinematic>

In this case, it takes 5 seconds to get to a 1 setting. As this is a software mechanization of a servo-actuator, there should be an output specified.

Positions must be given in ascending order.

By default, the input is assumed to be in the range [-1;1] and is scaled to the value specified in the last <position> tag. This behavior can be modified by adding a <noscale> tag to the component definition: in that case, the input value is directly used to determine the current position of the component.

Definition at line 113 of file FGKinemat.h.

Constructor & Destructor Documentation

◆ FGKinemat()

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

Constructor.

Parameters
fcsA reference to the current flight control system.
elementreference to the current configuration file node.

Definition at line 52 of file FGKinemat.cpp.

◆ ~FGKinemat()

JSBSim::FGKinemat::~FGKinemat ( )

Destructor.

Definition at line 87 of file FGKinemat.cpp.

Member Function Documentation

◆ GetOutputPct()

double JSBSim::FGKinemat::GetOutputPct ( void ) const
inlineoverridevirtual

Kinematic component output value.

Returns
the current output of the kinematic object on the range of [0,1].

Reimplemented from JSBSim::FGFCSComponent.

Definition at line 126 of file FGKinemat.h.

◆ Run()

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

Run method, overrides FGModel::Run().

Returns
false on success, true on failure. The routine doing the work.

Reimplemented from JSBSim::FGFCSComponent.

Definition at line 94 of file FGKinemat.cpp.


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