FlightGear next
JSBSim::FGFCS Class Reference

#include <FGFCS.h>

Inherits JSBSim::FGModel.

Public Member Functions

 FGFCS (FGFDMExec *)
 Constructor.
 
 ~FGFCS () override
 Destructor.
 
bool InitModel (void) override
 
bool Run (bool Holding) override
 Runs the Flight Controls model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold.
 
Pilot input command retrieval
double GetDaCmd (void) const
 Gets the aileron command.
 
double GetDeCmd (void) const
 Gets the elevator command.
 
double GetDrCmd (void) const
 Gets the rudder command.
 
double GetDsCmd (void) const
 Gets the steering command.
 
double GetDfCmd (void) const
 Gets the flaps command.
 
double GetDsbCmd (void) const
 Gets the speedbrake command.
 
double GetDspCmd (void) const
 Gets the spoiler command.
 
double GetThrottleCmd (int engine) const
 Gets the throttle command.
 
const std::vector< double > & GetThrottleCmd () const
 
double GetMixtureCmd (int engine) const
 Gets the mixture command.
 
const std::vector< double > & GetMixtureCmd () const
 
double GetPropAdvanceCmd (int engine) const
 Gets the prop pitch command.
 
bool GetFeatherCmd (int engine) const
 Gets the prop feather command.
 
double GetPitchTrimCmd (void) const
 Gets the pitch trim command.
 
double GetYawTrimCmd (void) const
 Gets the rudder trim command.
 
double GetRollTrimCmd (void) const
 Gets the aileron trim command.
 
double GetGearCmd (void) const
 Get the gear extend/retract command.
 
Aerosurface position retrieval
double GetDaLPos (int form=ofRad) const
 Gets the left aileron position.
 
double GetDaRPos (int form=ofRad) const
 Gets the right aileron position.
 
double GetDePos (int form=ofRad) const
 Gets the elevator position.
 
double GetDrPos (int form=ofRad) const
 Gets the rudder position.
 
double GetDsbPos (int form=ofRad) const
 Gets the speedbrake position.
 
double GetDspPos (int form=ofRad) const
 Gets the spoiler position.
 
double GetDfPos (int form=ofRad) const
 Gets the flaps position.
 
double GetThrottlePos (int engine) const
 Gets the throttle position.
 
const std::vector< double > & GetThrottlePos () const
 
double GetMixturePos (int engine) const
 Gets the mixture position.
 
const std::vector< double > & GetMixturePos () const
 
double GetGearPos (void) const
 Gets the gear position (0 up, 1 down), defaults to down.
 
double GetTailhookPos (void) const
 Gets the tailhook position (0 up, 1 down)
 
double GetWingFoldPos (void) const
 Gets the wing fold position (0 unfolded, 1 folded)
 
double GetPropAdvance (int engine) const
 Gets the prop pitch position.
 
const std::vector< double > & GetPropAdvance () const
 
bool GetPropFeather (int engine) const
 Gets the prop feather position.
 
const std::vector< bool > & GetPropFeather () const
 
std::string GetComponentStrings (const std::string &delimiter) const
 Retrieves all component names for inclusion in output stream.
 
std::string GetComponentValues (const std::string &delimiter) const
 Retrieves all component outputs for inclusion in output stream.
 
Pilot input command setting
void SetDaCmd (double cmd)
 Sets the aileron command.
 
void SetDeCmd (double cmd)
 Sets the elevator command.
 
void SetDrCmd (double cmd)
 Sets the rudder command.
 
void SetDsCmd (double cmd)
 Sets the steering command.
 
void SetDfCmd (double cmd)
 Sets the flaps command.
 
void SetDsbCmd (double cmd)
 Sets the speedbrake command.
 
void SetDspCmd (double cmd)
 Sets the spoilers command.
 
void SetPitchTrimCmd (double cmd)
 Sets the pitch trim command.
 
void SetYawTrimCmd (double cmd)
 Sets the rudder trim command.
 
void SetRollTrimCmd (double cmd)
 Sets the aileron trim command.
 
void SetThrottleCmd (int engine, double cmd)
 Sets the throttle command for the specified engine.
 
void SetMixtureCmd (int engine, double cmd)
 Sets the mixture command for the specified engine.
 
void SetGearCmd (double gearcmd)
 Set the gear extend/retract command, defaults to down.
 
void SetPropAdvanceCmd (int engine, double cmd)
 Sets the propeller pitch command for the specified engine.
 
void SetFeatherCmd (int engine, bool cmd)
 Sets the propeller feather command for the specified engine.
 
Aerosurface position setting
void SetDaLPos (int form, double pos)
 Sets the left aileron position.
 
void SetDaRPos (int form, double pos)
 Sets the right aileron position.
 
void SetDePos (int form, double pos)
 Sets the elevator position.
 
void SetDrPos (int form, double pos)
 Sets the rudder position.
 
void SetDfPos (int form, double pos)
 Sets the flaps position.
 
void SetDsbPos (int form, double pos)
 Sets the speedbrake position.
 
void SetDspPos (int form, double pos)
 Sets the spoiler position.
 
void SetThrottlePos (int engine, double cmd)
 Sets the actual throttle setting for the specified engine.
 
void SetMixturePos (int engine, double cmd)
 Sets the actual mixture setting for the specified engine.
 
void SetGearPos (double gearpos)
 Set the gear extend/retract position, defaults to down.
 
void SetTailhookPos (double hookpos)
 Set the tailhook position.
 
void SetWingFoldPos (double foldpos)
 Set the wing fold position.
 
void SetPropAdvance (int engine, double cmd)
 Sets the actual prop pitch setting for the specified engine.
 
void SetPropFeather (int engine, bool cmd)
 Sets the actual prop feather setting for the specified engine.
 
- Public Member Functions inherited from JSBSim::FGModel
 FGModel (FGFDMExec *)
 Constructor.
 
 ~FGModel () override
 Destructor.
 
bool InitModel (void) override
 
void SetRate (unsigned int tt)
 Set the ouput rate for the model in frames.
 
unsigned int GetRate (void)
 Get the output rate for the model in frames.
 
FGFDMExecGetExec (void)
 
void SetPropertyManager (FGPropertyManager *fgpm)
 
const std::string & GetName (void)
 
- Public Member Functions inherited from JSBSim::FGModelFunctions
virtual ~FGModelFunctions ()
 
void RunPreFunctions (void)
 
void RunPostFunctions (void)
 
bool Load (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PreLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
void PostLoad (Element *el, FGFDMExec *fdmex, std::string prefix="")
 
std::string GetFunctionStrings (const std::string &delimeter) const
 Gets the strings for the current set of functions.
 
std::string GetFunctionValues (const std::string &delimeter) const
 Gets the function values.
 
FGFunctionGetPreFunction (const std::string &name)
 Get one of the "pre" function.
 
- 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.
 

Landing Gear brakes

enum  SystemType { stFCS , stSystem , stAutoPilot }
 
void SetLBrake (double cmd)
 Sets the left brake group.
 
void SetRBrake (double cmd)
 Sets the right brake group.
 
void SetCBrake (double cmd)
 Sets the center brake group.
 
double GetBrake (FGLGear::BrakeGroup bg)
 Gets the brake for a specified group.
 
const std::vector< double > & GetBrakePos () const
 
double GetLBrake (void) const
 Gets the left brake.
 
double GetRBrake (void) const
 Gets the right brake.
 
double GetCBrake (void) const
 Gets the center brake.
 
bool Load (Element *el) override
 Loads the Flight Control System.
 
SGPath FindFullPathName (const SGPath &path) const override
 
void AddThrottle (void)
 
double GetDt (void) const
 
FGPropertyManagerGetPropertyManager (void)
 
bool GetTrimStatus (void) const
 
double GetChannelDeltaT (void) const
 

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::FGModel
bool Upload (Element *el, bool preLoad)
 Uploads this model in memory.
 
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- Protected Attributes inherited from JSBSim::FGModel
unsigned int exe_ctr
 
unsigned int rate
 
std::string Name
 
FGFDMExecFDMExec
 
FGPropertyManagerPropertyManager
 
- Protected Attributes inherited from JSBSim::FGModelFunctions
std::vector< FGFunction * > PreFunctions
 
std::vector< FGFunction * > PostFunctions
 
FGPropertyReader LocalProperties
 
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

Definition at line 187 of file FGFCS.h.

Member Enumeration Documentation

◆ SystemType

Enumerator
stFCS 
stSystem 
stAutoPilot 

Definition at line 533 of file FGFCS.h.

Constructor & Destructor Documentation

◆ FGFCS()

JSBSim::FGFCS::FGFCS ( FGFDMExec * fdm)

Constructor.

Parameters
Executivea pointer to the parent executive object

Definition at line 72 of file FGFCS.cpp.

◆ ~FGFCS()

JSBSim::FGFCS::~FGFCS ( )
override

Destructor.

Definition at line 96 of file FGFCS.cpp.

Member Function Documentation

◆ AddThrottle()

void JSBSim::FGFCS::AddThrottle ( void )

Definition at line 671 of file FGFCS.cpp.

◆ FindFullPathName()

SGPath JSBSim::FGFCS::FindFullPathName ( const SGPath & path) const
overridevirtual

Reimplemented from JSBSim::FGModel.

Definition at line 611 of file FGFCS.cpp.

◆ GetBrake()

double JSBSim::FGFCS::GetBrake ( FGLGear::BrakeGroup bg)

Gets the brake for a specified group.

Parameters
bgwhich brakegroup to retrieve the command for
Returns
the brake setting for the supplied brake group argument

Definition at line 604 of file FGFCS.cpp.

◆ GetBrakePos()

const std::vector< double > & JSBSim::FGFCS::GetBrakePos ( ) const
inline

Definition at line 518 of file FGFCS.h.

◆ GetCBrake()

double JSBSim::FGFCS::GetCBrake ( void ) const
inline

Gets the center brake.

Returns
the center brake setting.

Definition at line 530 of file FGFCS.h.

◆ GetChannelDeltaT()

double JSBSim::FGFCS::GetChannelDeltaT ( void ) const
inline

Definition at line 549 of file FGFCS.h.

◆ GetComponentStrings()

string JSBSim::FGFCS::GetComponentStrings ( const std::string & delimiter) const

Retrieves all component names for inclusion in output stream.

Parameters
delimitereither a tab or comma string depending on output type
Returns
a string containing the descriptive names for all components

Definition at line 624 of file FGFCS.cpp.

◆ GetComponentValues()

string JSBSim::FGFCS::GetComponentValues ( const std::string & delimiter) const

Retrieves all component outputs for inclusion in output stream.

Parameters
delimitereither a tab or comma string depending on output type
Returns
a string containing the numeric values for the current set of component outputs

Definition at line 647 of file FGFCS.cpp.

◆ GetDaCmd()

double JSBSim::FGFCS::GetDaCmd ( void ) const
inline

Gets the aileron command.

Returns
aileron command in range from -1.0 - 1.0

Definition at line 212 of file FGFCS.h.

◆ GetDaLPos()

double JSBSim::FGFCS::GetDaLPos ( int form = ofRad) const
inline

Gets the left aileron position.

Returns
aileron position in radians

Definition at line 284 of file FGFCS.h.

◆ GetDaRPos()

double JSBSim::FGFCS::GetDaRPos ( int form = ofRad) const
inline

Gets the right aileron position.

Returns
aileron position in radians

Definition at line 289 of file FGFCS.h.

◆ GetDeCmd()

double JSBSim::FGFCS::GetDeCmd ( void ) const
inline

Gets the elevator command.

Returns
elevator command in range from -1.0 - 1.0

Definition at line 216 of file FGFCS.h.

◆ GetDePos()

double JSBSim::FGFCS::GetDePos ( int form = ofRad) const
inline

Gets the elevator position.

Returns
elevator position in radians

Definition at line 294 of file FGFCS.h.

◆ GetDfCmd()

double JSBSim::FGFCS::GetDfCmd ( void ) const
inline

Gets the flaps command.

Returns
flaps command in range from 0 to 1.0

Definition at line 228 of file FGFCS.h.

◆ GetDfPos()

double JSBSim::FGFCS::GetDfPos ( int form = ofRad) const
inline

Gets the flaps position.

Returns
flaps position in radians

Definition at line 314 of file FGFCS.h.

◆ GetDrCmd()

double JSBSim::FGFCS::GetDrCmd ( void ) const
inline

Gets the rudder command.

Returns
rudder command in range from -1.0 - 1.0

Definition at line 220 of file FGFCS.h.

◆ GetDrPos()

double JSBSim::FGFCS::GetDrPos ( int form = ofRad) const
inline

Gets the rudder position.

Returns
rudder position in radians

Definition at line 299 of file FGFCS.h.

◆ GetDsbCmd()

double JSBSim::FGFCS::GetDsbCmd ( void ) const
inline

Gets the speedbrake command.

Returns
speedbrake command in range from 0 to 1.0

Definition at line 232 of file FGFCS.h.

◆ GetDsbPos()

double JSBSim::FGFCS::GetDsbPos ( int form = ofRad) const
inline

Gets the speedbrake position.

Returns
speedbrake position in radians

Definition at line 304 of file FGFCS.h.

◆ GetDsCmd()

double JSBSim::FGFCS::GetDsCmd ( void ) const
inline

Gets the steering command.

Returns
steering command in range from -1.0 - 1.0

Definition at line 224 of file FGFCS.h.

◆ GetDspCmd()

double JSBSim::FGFCS::GetDspCmd ( void ) const
inline

Gets the spoiler command.

Returns
spoiler command in range from 0 to 1.0

Definition at line 236 of file FGFCS.h.

◆ GetDspPos()

double JSBSim::FGFCS::GetDspPos ( int form = ofRad) const
inline

Gets the spoiler position.

Returns
spoiler position in radians

Definition at line 309 of file FGFCS.h.

◆ GetDt()

double JSBSim::FGFCS::GetDt ( void ) const

Definition at line 688 of file FGFCS.cpp.

◆ GetFeatherCmd()

bool JSBSim::FGFCS::GetFeatherCmd ( int engine) const
inline

Gets the prop feather command.

Parameters
engineengine ID number
Returns
feather command for the given engine (on / off)

Definition at line 260 of file FGFCS.h.

◆ GetGearCmd()

double JSBSim::FGFCS::GetGearCmd ( void ) const
inline

Get the gear extend/retract command.

0 commands gear up, 1 down. defaults to down.

Returns
the current value of the gear extend/retract command

Definition at line 277 of file FGFCS.h.

◆ GetGearPos()

double JSBSim::FGFCS::GetGearPos ( void ) const
inline

Gets the gear position (0 up, 1 down), defaults to down.

Returns
gear position (0 up, 1 down)

Definition at line 333 of file FGFCS.h.

◆ GetLBrake()

double JSBSim::FGFCS::GetLBrake ( void ) const
inline

Gets the left brake.

Returns
the left brake setting.

Definition at line 522 of file FGFCS.h.

◆ GetMixtureCmd() [1/2]

const std::vector< double > & JSBSim::FGFCS::GetMixtureCmd ( ) const
inline

Definition at line 250 of file FGFCS.h.

◆ GetMixtureCmd() [2/2]

double JSBSim::FGFCS::GetMixtureCmd ( int engine) const
inline

Gets the mixture command.

Parameters
engineengine ID number
Returns
mixture command in range from 0 - 1.0 for the given engine

Definition at line 248 of file FGFCS.h.

◆ GetMixturePos() [1/2]

const std::vector< double > & JSBSim::FGFCS::GetMixturePos ( ) const
inline

Definition at line 329 of file FGFCS.h.

◆ GetMixturePos() [2/2]

double JSBSim::FGFCS::GetMixturePos ( int engine) const
inline

Gets the mixture position.

Parameters
engineengine ID number
Returns
mixture position for the given engine in range from 0 - 1.0

Definition at line 327 of file FGFCS.h.

◆ GetPitchTrimCmd()

double JSBSim::FGFCS::GetPitchTrimCmd ( void ) const
inline

Gets the pitch trim command.

Returns
pitch trim command in range from -1.0 to 1.0

Definition at line 264 of file FGFCS.h.

◆ GetPropAdvance() [1/2]

const std::vector< double > & JSBSim::FGFCS::GetPropAdvance ( ) const
inline

Definition at line 348 of file FGFCS.h.

◆ GetPropAdvance() [2/2]

double JSBSim::FGFCS::GetPropAdvance ( int engine) const
inline

Gets the prop pitch position.

Parameters
engineengine ID number
Returns
prop pitch position for the given engine in range from 0 - 1.0

Definition at line 346 of file FGFCS.h.

◆ GetPropAdvanceCmd()

double JSBSim::FGFCS::GetPropAdvanceCmd ( int engine) const
inline

Gets the prop pitch command.

Parameters
engineengine ID number
Returns
pitch command in range from 0.0 - 1.0 for the given engine

Definition at line 255 of file FGFCS.h.

◆ GetPropertyManager()

FGPropertyManager * JSBSim::FGFCS::GetPropertyManager ( void )
inline

Definition at line 546 of file FGFCS.h.

◆ GetPropFeather() [1/2]

const std::vector< bool > & JSBSim::FGFCS::GetPropFeather ( ) const
inline

Definition at line 355 of file FGFCS.h.

◆ GetPropFeather() [2/2]

bool JSBSim::FGFCS::GetPropFeather ( int engine) const
inline

Gets the prop feather position.

Parameters
engineengine ID number
Returns
prop fether for the given engine (on / off)

Definition at line 353 of file FGFCS.h.

◆ GetRBrake()

double JSBSim::FGFCS::GetRBrake ( void ) const
inline

Gets the right brake.

Returns
the right brake setting.

Definition at line 526 of file FGFCS.h.

◆ GetRollTrimCmd()

double JSBSim::FGFCS::GetRollTrimCmd ( void ) const
inline

Gets the aileron trim command.

Returns
aileron trim command in range from -1.0 - 1.0

Definition at line 272 of file FGFCS.h.

◆ GetTailhookPos()

double JSBSim::FGFCS::GetTailhookPos ( void ) const
inline

Gets the tailhook position (0 up, 1 down)

Returns
tailhook position (0 up, 1 down)

Definition at line 337 of file FGFCS.h.

◆ GetThrottleCmd() [1/2]

const std::vector< double > & JSBSim::FGFCS::GetThrottleCmd ( ) const
inline

Definition at line 243 of file FGFCS.h.

◆ GetThrottleCmd() [2/2]

double JSBSim::FGFCS::GetThrottleCmd ( int engine) const

Gets the throttle command.

Parameters
engineengine ID number
Returns
throttle command in range from 0 - 1.0 for the given engine

Definition at line 351 of file FGFCS.cpp.

◆ GetThrottlePos() [1/2]

const std::vector< double > & JSBSim::FGFCS::GetThrottlePos ( ) const
inline

Definition at line 322 of file FGFCS.h.

◆ GetThrottlePos() [2/2]

double JSBSim::FGFCS::GetThrottlePos ( int engine) const

Gets the throttle position.

Parameters
engineengine ID number
Returns
throttle position for the given engine in range from 0 - 1.0

Definition at line 369 of file FGFCS.cpp.

◆ GetTrimStatus()

bool JSBSim::FGFCS::GetTrimStatus ( void ) const
inline

Definition at line 548 of file FGFCS.h.

◆ GetWingFoldPos()

double JSBSim::FGFCS::GetWingFoldPos ( void ) const
inline

Gets the wing fold position (0 unfolded, 1 folded)

Returns
wing fold position (0 unfolded, 1 folded)

Definition at line 341 of file FGFCS.h.

◆ GetYawTrimCmd()

double JSBSim::FGFCS::GetYawTrimCmd ( void ) const
inline

Gets the rudder trim command.

Returns
rudder trim command in range from -1.0 - 1.0

Definition at line 268 of file FGFCS.h.

◆ InitModel()

bool JSBSim::FGFCS::InitModel ( void )
overridevirtual

Reimplemented from JSBSim::FGModelFunctions.

Definition at line 117 of file FGFCS.cpp.

◆ Load()

bool JSBSim::FGFCS::Load ( Element * el)
overridevirtual

Loads the Flight Control System.

Load() is called from FGFDMExec.

Parameters
elpointer to the Element instance
Returns
true if succesful

Reimplemented from JSBSim::FGModel.

Definition at line 471 of file FGFCS.cpp.

◆ Run()

bool JSBSim::FGFCS::Run ( bool Holding)
overridevirtual

Runs the Flight Controls model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold.

Parameters
Holdingif true, the executive has been directed to hold the sim from advancing time. Some models may ignore this flag, such as the Input model, which may need to be active to listen on a socket for the "Resume" command to be given.
Returns
false if no error

Reimplemented from JSBSim::FGModel.

Definition at line 153 of file FGFCS.cpp.

◆ SetCBrake()

void JSBSim::FGFCS::SetCBrake ( double cmd)
inline

Sets the center brake group.

Parameters
cmdbrake setting in percent (0.0 - 1.0)

Definition at line 511 of file FGFCS.h.

◆ SetDaCmd()

void JSBSim::FGFCS::SetDaCmd ( double cmd)
inline

Sets the aileron command.

Parameters
cmdaileron command

Definition at line 373 of file FGFCS.h.

◆ SetDaLPos()

void JSBSim::FGFCS::SetDaLPos ( int form,
double pos )

Sets the left aileron position.

Parameters
cmdleft aileron position in radians

Definition at line 182 of file FGFCS.cpp.

◆ SetDaRPos()

void JSBSim::FGFCS::SetDaRPos ( int form,
double pos )

Sets the right aileron position.

Parameters
cmdright aileron position in radians

Definition at line 201 of file FGFCS.cpp.

◆ SetDeCmd()

void JSBSim::FGFCS::SetDeCmd ( double cmd)
inline

Sets the elevator command.

Parameters
cmdelevator command in percent

Definition at line 377 of file FGFCS.h.

◆ SetDePos()

void JSBSim::FGFCS::SetDePos ( int form,
double pos )

Sets the elevator position.

Parameters
cmdelevator position in radians

Definition at line 220 of file FGFCS.cpp.

◆ SetDfCmd()

void JSBSim::FGFCS::SetDfCmd ( double cmd)
inline

Sets the flaps command.

Parameters
cmdflaps command in percent

Definition at line 389 of file FGFCS.h.

◆ SetDfPos()

void JSBSim::FGFCS::SetDfPos ( int form,
double pos )

Sets the flaps position.

Parameters
cmdflaps position in radians

Definition at line 258 of file FGFCS.cpp.

◆ SetDrCmd()

void JSBSim::FGFCS::SetDrCmd ( double cmd)
inline

Sets the rudder command.

Parameters
cmdrudder command in percent

Definition at line 381 of file FGFCS.h.

◆ SetDrPos()

void JSBSim::FGFCS::SetDrPos ( int form,
double pos )

Sets the rudder position.

Parameters
cmdrudder position in radians

Definition at line 239 of file FGFCS.cpp.

◆ SetDsbCmd()

void JSBSim::FGFCS::SetDsbCmd ( double cmd)
inline

Sets the speedbrake command.

Parameters
cmdspeedbrake command in percent

Definition at line 393 of file FGFCS.h.

◆ SetDsbPos()

void JSBSim::FGFCS::SetDsbPos ( int form,
double pos )

Sets the speedbrake position.

Parameters
cmdspeedbrake position in radians

Definition at line 277 of file FGFCS.cpp.

◆ SetDsCmd()

void JSBSim::FGFCS::SetDsCmd ( double cmd)
inline

Sets the steering command.

Parameters
cmdsteering command in percent

Definition at line 385 of file FGFCS.h.

◆ SetDspCmd()

void JSBSim::FGFCS::SetDspCmd ( double cmd)
inline

Sets the spoilers command.

Parameters
cmdspoilers command in percent

Definition at line 397 of file FGFCS.h.

◆ SetDspPos()

void JSBSim::FGFCS::SetDspPos ( int form,
double pos )

Sets the spoiler position.

Parameters
cmdspoiler position in radians

Definition at line 296 of file FGFCS.cpp.

◆ SetFeatherCmd()

void JSBSim::FGFCS::SetFeatherCmd ( int engine,
bool cmd )

Sets the propeller feather command for the specified engine.

Parameters
engineengine ID number
cmdfeather (bool)

Definition at line 443 of file FGFCS.cpp.

◆ SetGearCmd()

void JSBSim::FGFCS::SetGearCmd ( double gearcmd)
inline

Set the gear extend/retract command, defaults to down.

Parameters
gearcommand 0 for up, 1 for down

Definition at line 423 of file FGFCS.h.

◆ SetGearPos()

void JSBSim::FGFCS::SetGearPos ( double gearpos)
inline

Set the gear extend/retract position, defaults to down.

Parameters
gearposition 0 up, 1 down

Definition at line 478 of file FGFCS.h.

◆ SetLBrake()

void JSBSim::FGFCS::SetLBrake ( double cmd)
inline

Sets the left brake group.

Parameters
cmdbrake setting in percent (0.0 - 1.0)

Definition at line 503 of file FGFCS.h.

◆ SetMixtureCmd()

void JSBSim::FGFCS::SetMixtureCmd ( int engine,
double cmd )

Sets the mixture command for the specified engine.

Parameters
engineengine ID number
cmdnormalized mixture command (0.0 - 1.0)

Definition at line 387 of file FGFCS.cpp.

◆ SetMixturePos()

void JSBSim::FGFCS::SetMixturePos ( int engine,
double cmd )

Sets the actual mixture setting for the specified engine.

Parameters
engineengine ID number
cmdnormalized mixture setting (0.0 - 1.0)

Definition at line 401 of file FGFCS.cpp.

◆ SetPitchTrimCmd()

void JSBSim::FGFCS::SetPitchTrimCmd ( double cmd)
inline

Sets the pitch trim command.

Parameters
cmdpitch trim command in percent

Definition at line 401 of file FGFCS.h.

◆ SetPropAdvance()

void JSBSim::FGFCS::SetPropAdvance ( int engine,
double cmd )

Sets the actual prop pitch setting for the specified engine.

Parameters
engineengine ID number
cmdprop pitch setting in percent (0.0 - 1.0)

Definition at line 429 of file FGFCS.cpp.

◆ SetPropAdvanceCmd()

void JSBSim::FGFCS::SetPropAdvanceCmd ( int engine,
double cmd )

Sets the propeller pitch command for the specified engine.

Parameters
engineengine ID number
cmdpitch command in percent (0.0 - 1.0)

Definition at line 415 of file FGFCS.cpp.

◆ SetPropFeather()

void JSBSim::FGFCS::SetPropFeather ( int engine,
bool cmd )

Sets the actual prop feather setting for the specified engine.

Parameters
engineengine ID number
cmdprop fether setting (bool)

Definition at line 457 of file FGFCS.cpp.

◆ SetRBrake()

void JSBSim::FGFCS::SetRBrake ( double cmd)
inline

Sets the right brake group.

Parameters
cmdbrake setting in percent (0.0 - 1.0)

Definition at line 507 of file FGFCS.h.

◆ SetRollTrimCmd()

void JSBSim::FGFCS::SetRollTrimCmd ( double cmd)
inline

Sets the aileron trim command.

Parameters
cmdaileron trim command in percent

Definition at line 409 of file FGFCS.h.

◆ SetTailhookPos()

void JSBSim::FGFCS::SetTailhookPos ( double hookpos)
inline

Set the tailhook position.

Parameters
tailhookposition 0 up, 1 down

Definition at line 482 of file FGFCS.h.

◆ SetThrottleCmd()

void JSBSim::FGFCS::SetThrottleCmd ( int engine,
double cmd )

Sets the throttle command for the specified engine.

Parameters
engineengine ID number
cmdnormalized throttle command (0.0 - 1.0)

Definition at line 315 of file FGFCS.cpp.

◆ SetThrottlePos()

void JSBSim::FGFCS::SetThrottlePos ( int engine,
double cmd )

Sets the actual throttle setting for the specified engine.

Parameters
engineengine ID number
cmdnormalized throttle setting (0.0 - 1.0)

Definition at line 333 of file FGFCS.cpp.

◆ SetWingFoldPos()

void JSBSim::FGFCS::SetWingFoldPos ( double foldpos)
inline

Set the wing fold position.

Parameters
wingfold position 0 unfolded, 1 folded

Definition at line 486 of file FGFCS.h.

◆ SetYawTrimCmd()

void JSBSim::FGFCS::SetYawTrimCmd ( double cmd)
inline

Sets the rudder trim command.

Parameters
cmdrudder trim command in percent

Definition at line 405 of file FGFCS.h.


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