JSBSim Flight Dynamics Model  1.0 (02 March 2017)
An Open Source Flight Dynamics and Control Software Library in C++
FGInputType Class Referenceabstract

Abstract class to provide functions generic to all the input directives. More...

#include <FGInputType.h>

+ Inheritance diagram for FGInputType:
+ Collaboration diagram for FGInputType:

Public Member Functions

 FGInputType (FGFDMExec *fdmex)
 Constructor (implement the FGModel interface). More...
 
virtual ~FGInputType ()
 Destructor.
 
void Disable (void)
 Disables the input generation.
 
void Enable (void)
 Enables the input generation.
 
virtual const std::string & GetInputName (void) const
 Get the name identifier to which the input will be directed. More...
 
virtual bool InitModel (void)
 Init the input model according to its configitation.
 
virtual bool Load (Element *el)
 Init the input directives from an XML file (implement the FGModel interface). More...
 
virtual void Read (bool Holding)=0
 Generate the input. More...
 
bool Run (bool Holding)
 Executes the input directives (implement the FGModel interface). More...
 
void SetIdx (unsigned int idx)
 Set the idx for this input instance. More...
 
virtual void SetInputName (const std::string &name)
 Overwrites the name identifier under which the input will be read. More...
 
bool Toggle (void)
 Toggles the input generation. More...
 
- Public Member Functions inherited from FGModel
 FGModel (FGFDMExec *)
 Constructor.
 
virtual ~FGModel ()
 Destructor.
 
virtual SGPath FindFullPathName (const SGPath &path) const
 
FGFDMExecGetExec (void)
 
unsigned int GetRate (void)
 Get the output rate for the model in frames.
 
void SetPropertyManager (FGPropertyManager *fgpm)
 
void SetRate (unsigned int tt)
 Set the ouput rate for the model in frames.
 
- Public Member Functions inherited from FGModelFunctions
std::string GetFunctionStrings (const std::string &delimeter) const
 Gets the strings for the current set of functions. More...
 
std::string GetFunctionValues (const std::string &delimeter) const
 Gets the function values. More...
 
FGFunctionGetPreFunction (const std::string &name)
 Get one of the "pre" function. More...
 
bool Load (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
 
void PostLoad (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
 
void PreLoad (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
 
void RunPostFunctions (void)
 
void RunPreFunctions (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.
 
std::string GetVersion (void)
 Returns the version number of JSBSim. More...
 
void PutMessage (const Message &msg)
 Places a Message structure on the Message queue. More...
 
void PutMessage (const std::string &text)
 Creates a message with the given text and places it on the queue. More...
 
void PutMessage (const std::string &text, bool bVal)
 Creates a message with the given text and boolean value and places it on the queue. More...
 
void PutMessage (const std::string &text, int iVal)
 Creates a message with the given text and integer value and places it on the queue. More...
 
void PutMessage (const std::string &text, double dVal)
 Creates a message with the given text and double value and places it on the queue. More...
 
int SomeMessages (void)
 Reads the message on the queue (but does not delete it). More...
 
void ProcessMessage (void)
 Reads the message on the queue and removes it from the queue. More...
 
MessageProcessNextMessage (void)
 Reads the next message on the queue and removes it from the queue. More...
 

Protected Member Functions

void Debug (int from)
 
- Protected Member Functions inherited from FGJSBBase
void Debug (int)
 

Protected Attributes

bool enabled
 
unsigned int InputIdx
 
- Protected Attributes inherited from FGModel
unsigned int exe_ctr
 
FGFDMExecFDMExec
 
FGPropertyManagerPropertyManager
 
unsigned int rate
 
- Protected Attributes inherited from FGModelFunctions
FGPropertyReader LocalProperties
 
std::vector< FGFunction * > PostFunctions
 
std::vector< FGFunction * > PreFunctions
 

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 double CelsiusToFahrenheit (double celsius)
 Converts from degrees Celsius to degrees Fahrenheit. More...
 
static double CelsiusToKelvin (double celsius)
 Converts from degrees Celsius to degrees Kelvin. More...
 
static double CelsiusToRankine (double celsius)
 Converts from degrees Celsius to degrees Rankine. More...
 
static double Constrain (double min, double value, double max)
 Constrain a value between a minimum and a maximum value.
 
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 double FahrenheitToCelsius (double fahrenheit)
 Converts from degrees Fahrenheit to degrees Celsius. More...
 
static double FeetToMeters (double measure)
 Converts from feet to meters. More...
 
static double GaussianRandomNumber (void)
 
static double KelvinToCelsius (double kelvin)
 Converts from degrees Kelvin to degrees Celsius. More...
 
static double KelvinToFahrenheit (double kelvin)
 Converts from degrees Kelvin to degrees Fahrenheit. More...
 
static double KelvinToRankine (double kelvin)
 Converts from degrees Kelvin to degrees Rankine. More...
 
static double MachFromVcalibrated (double vcas, double p, double psl, double rhosl)
 Calculate the Mach number from the calibrated airspeed. More...
 
static double PitotTotalPressure (double mach, double p)
 Compute the total pressure in front of the Pitot tube. More...
 
static double RankineToCelsius (double rankine)
 Converts from degrees Rankine to degrees Celsius. More...
 
static double RankineToKelvin (double rankine)
 Converts from degrees Rankine to degrees Kelvin. More...
 
static double sign (double num)
 
static double VcalibratedFromMach (double mach, double p, double psl, double rhosl)
 Calculate the calibrated airspeed from the Mach number. More...
 
- Public Attributes inherited from FGModel
std::string Name
 
- Static Public Attributes inherited from FGJSBBase
static short debug_lvl = 1
 
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 Protected Member Functions inherited from FGJSBBase
static std::string CreateIndexedPropertyName (const std::string &Property, int index)
 
- Static Protected Attributes inherited from FGJSBBase
static const double degtorad = 0.017453292519943295769236907684886
 
static const double fpstokts = 1.0/ktstofps
 
static const double fttom = 0.3048
 
static int gaussian_random_number_phase = 0
 
static const double hptoftlbssec = 550.0
 
static const double in3tom3 = 1.638706E-5
 
static const double inchtoft = 0.08333333
 
static const double inhgtopa = 3386.38
 
static const std::string JSBSim_version = "1.0 " __DATE__ " " __TIME__
 
static const double kgtolb = 2.20462
 
static const double kgtoslug = 0.06852168
 
static const double ktstofps = 1.68781
 
static const double lbtoslug = 1.0/slugtolb
 
static Message localMsg
 
static const double m3toft3 = 1.0/(fttom*fttom*fttom)
 
static double Mair = 28.9645
 
static unsigned int messageId = 0
 
static std::queue< MessageMessages
 
static const std::string needed_cfg_version = "2.0"
 
static const double psftoinhg = 0.014138
 
static const double psftopa = 47.88
 
static const double radtodeg = 57.295779513082320876798154814105
 
static double Reng = 1716.56
 
static double Rstar = 1545.348
 
static const double SHRatio = 1.40
 
static const double slugtolb = 32.174049
 

Detailed Description

Abstract class to provide functions generic to all the input directives.

This class is used by the input manager FGInput to manage a list of different input classes without needing to know the details of each one of them. It also provides the functions that are common to all the input classes.

The class inherits from FGModelFunctions so it is possible to define functions that execute before or after the input is generated. Such functions need to be tagged with a "pre" or "post" type attribute to denote the sequence in which they should be executed.

The class mimics some functionalities of FGModel (methods InitModel(), Run() and SetRate()). However it does not inherit from FGModel since it is conceptually different from the model paradigm.

Definition at line 79 of file FGInputType.h.

Constructor & Destructor Documentation

◆ FGInputType()

FGInputType ( FGFDMExec fdmex)

Constructor (implement the FGModel interface).

Parameters
fdmexa pointer to the parent executive object

Definition at line 58 of file FGInputType.cpp.

58  :
59  FGModel(fdmex),
60  enabled(true)
61 {
62  Debug(0);
63 }
FGModel(FGFDMExec *)
Constructor.
Definition: FGModel.cpp:60

Member Function Documentation

◆ GetInputName()

virtual const std::string& GetInputName ( void  ) const
inlinevirtual

Get the name identifier to which the input will be directed.

Returns
the name identifier.

Definition at line 135 of file FGInputType.h.

135 { return Name; }

◆ Load()

bool Load ( Element el)
virtual

Init the input directives from an XML file (implement the FGModel interface).

Parameters
elementXML Element that is pointing to the input directives

Reimplemented from FGModel.

Reimplemented in FGInputSocket, and FGUDPInputSocket.

Definition at line 81 of file FGInputType.cpp.

82 {
83  // Perform base class Load.
84  if(!FGModel::Load(element))
85  return false;
86 
87  // no common attributes yet (see FGOutputType for example
88 
89  // FIXME : PostLoad should be called in the most derived class ?
90  PostLoad(element, PropertyManager);
91 
92  return true;
93 }
virtual bool Load(Element *el)
Loads this model.
Definition: FGModel.cpp:113
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Read()

virtual void Read ( bool  Holding)
pure virtual

Generate the input.

This is a pure method so it must be implemented by the classes that inherits from FGInputType. The Read name may not be relevant to all inputs but it has been kept for backward compatibility.

Implemented in FGInputSocket, and FGUDPInputSocket.

+ Here is the caller graph for this function:

◆ Run()

bool Run ( bool  Holding)
virtual

Executes the input directives (implement the FGModel interface).

This method checks that the current time step matches the input rate and calls the registered "pre" functions, the input generation and finally the "post" functions.

Returns
false if no error.

Reimplemented from FGModel.

Definition at line 107 of file FGInputType.cpp.

108 {
109  if (FGModel::Run(Holding)) return true;
110  if (!enabled) return true;
111 
112  RunPreFunctions();
113  Read(Holding);
114  RunPostFunctions();
115 
116  Debug(4);
117 
118  return false;
119 }
virtual bool Run(bool Holding)
Runs the model; called by the Executive.
Definition: FGModel.cpp:92
virtual void Read(bool Holding)=0
Generate the input.
+ Here is the call graph for this function:

◆ SetIdx()

void SetIdx ( unsigned int  idx)

Set the idx for this input instance.

Parameters
idxID of the input instance that is constructed

Definition at line 74 of file FGInputType.cpp.

75 {
76  InputIdx = idx;
77 }
+ Here is the caller graph for this function:

◆ SetInputName()

virtual void SetInputName ( const std::string &  name)
inlinevirtual

Overwrites the name identifier under which the input will be read.

This method is taken into account if it is called before FGFDMExec::RunIC() otherwise it is ignored until the next call to SetStartNewInput().

Parameters
namenew name

Definition at line 131 of file FGInputType.h.

131 { Name = name; }

◆ Toggle()

bool Toggle ( void  )
inline

Toggles the input generation.

Returns
the input generation status i.e. true if the input has been enabled, false if the input has been disabled.

Definition at line 124 of file FGInputType.h.

124 {enabled = !enabled; return enabled;}

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