FlightGear: JSBSim::FGInput Class Reference

Handles simulation input. More...

#include <FGInput.h>

Public Member Functions
	FGInput (FGFDMExec *)

	~FGInput () override

bool	Load (Element *el) override
	Load the input directives and adds a new input instance to the Input Manager list.

bool	InitModel (void) override
	Initializes the instance.

bool	Run (bool Holding) override
	Runs the Input model; called by the Executive Can pass in a value indicating if the executive is directing the simulation to Hold.

bool	SetDirectivesFile (const SGPath &fname)
	Adds a new input instance to the Input Manager.

void	Enable (void)
	Enables the input generation for all input instances.

void	Disable (void)
	Disables the input generation for all input instances.

bool	Toggle (int idx)
	Toggles the input generation of each input instance.

bool	SetInputName (unsigned int idx, const std::string &name)
	Overwrites the name identifier under which the input will be logged.

std::string	GetInputName (unsigned int idx) const
	Get the name identifier to which the input will be directed.

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.

FGFDMExec *	GetExec (void)

void	SetPropertyManager (FGPropertyManager *fgpm)

virtual SGPath	FindFullPathName (const SGPath &path) const

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.

FGFunction *	GetPreFunction (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.

Message *	ProcessNextMessage (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::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

FGFDMExec *	FDMExec

FGPropertyManager *	PropertyManager

Protected Attributes inherited from JSBSim::FGModelFunctions
std::vector< FGFunction * >	PreFunctions

std::vector< FGFunction * >	PostFunctions

FGPropertyReader	LocalProperties

static Message	localMsg

static std::queue< Message >	Messages

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/(fttomfttomfttom)

static constexpr double	in3tom3 = inchtoftinchtoftinchtoft/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

Handles simulation input.

INPUT section definition

The following specifies the way that JSBSim writes out data.

    NAME is the filename you want the input to come from

    TYPE can be:
      SOCKET      Will eventually send data to a socket input, where NAME
                  would then be the IP address of the machine the data should
                  be sent to. DON'T USE THIS YET!
      NONE        Specifies to do nothing. This setting makes it easy to turn on and
                  off the data input without having to mess with anything else.

      Examples:

The class FGInput is the manager of the inputs requested by the user. It
manages a list of instances derived from the abstract class FGInputType.

Definition at line 84 of file FGInput.h.

Constructor & Destructor Documentation

◆ FGInput()

FGInput::FGInput ( FGFDMExec * fdmex )

Definition at line 55 of file FGInput.cpp.

◆ ~FGInput()

FGInput::~FGInput ( )

override

Definition at line 65 of file FGInput.cpp.

Member Function Documentation

◆ Disable()

void JSBSim::FGInput::Disable ( void )

inline

Disables the input generation for all input instances.

Definition at line 123 of file FGInput.h.

◆ Enable()

void JSBSim::FGInput::Enable ( void )

inline

Enables the input generation for all input instances.

Definition at line 121 of file FGInput.h.

◆ GetInputName()

string FGInput::GetInputName ( unsigned int idx ) const

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

Parameters

idx	ID of the input instance from which the name identifier must be obtained

Returns: the name identifier.

Definition at line 190 of file FGInput.cpp.

◆ InitModel()

bool FGInput::InitModel ( void )

overridevirtual

Initializes the instance.

This method is called by FGFDMExec::RunIC(). This is were the initialization of all classes derived from FGInputType takes place. It is important that this method is not called prior to FGFDMExec::RunIC() so that the initialization process can be executed properly.

Returns: true if the execution succeeded.

Reimplemented from JSBSim::FGModelFunctions.

Definition at line 121 of file FGInput.cpp.

◆ Load()

bool FGInput::Load ( Element * el )

overridevirtual

Load the input directives and adds a new input instance to the Input Manager list.

Parameters

el	XMLElement that is pointing to the input directives

Returns: true if the execution succeeded.

Reimplemented from JSBSim::FGModel.

Definition at line 76 of file FGInput.cpp.

◆ Run()

bool FGInput::Run ( bool Holding )

overridevirtual

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

Parameters

Holding if 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 136 of file FGInput.cpp.

◆ SetDirectivesFile()

bool FGInput::SetDirectivesFile ( const SGPath & fname )

Adds a new input instance to the Input Manager.

The definition of the new input instance is read from a file.

Parameters

fname the name of the file from which the ouput directives should be read.

Returns: true if the execution succeeded.

Definition at line 151 of file FGInput.cpp.

◆ SetInputName()

bool FGInput::SetInputName	(	unsigned int	idx,
		const std::string &	name )

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

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

Parameters

idx	ID of the instance which name identifier will be changed
name	new name

Returns: false if the instance does not exists.

Definition at line 180 of file FGInput.cpp.

◆ Toggle()

bool FGInput::Toggle ( int idx )

Toggles the input generation of each input instance.

Parameters

idx	ID of the input instance which input generation will be toggled.

Returns: false if the instance does not exist otherwise returns the status of the input generation (i.e. true if the input has been enabled, false if the input has been disabled)

Definition at line 170 of file FGInput.cpp.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FGInput()

◆ ~FGInput()

Member Function Documentation

◆ Disable()

◆ Enable()

◆ GetInputName()

◆ InitModel()

◆ Load()

◆ Run()

◆ SetDirectivesFile()

◆ SetInputName()

◆ Toggle()