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 73 of file FGInputType.h.

#include <FGInputType.h>

Inheritance diagram for FGInputType:

Collaboration diagram for FGInputType:

Public Member Functions
	FGInputType (FGFDMExec *fdmex)
	Constructor (implement the FGModel interface).

	~FGInputType () override
	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.

bool	InitModel (void) override
	Init the input model according to its configitation.

bool	Load (Element *el) override
	Init the input directives from an XML file (implement the FGModel interface).

virtual void	Read (bool Holding)=0
	Generate the input.

bool	Run (bool Holding) override
	Executes the input directives (implement the FGModel interface).

void	SetIdx (unsigned int idx)
	Set the idx for this input instance.

virtual void	SetInputName (const std::string &name)
	Overwrites the name identifier under which the input will be read.

bool	Toggle (void)
	Toggles the input generation.

Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *)
	Constructor.

	~FGModel () override
	Destructor.

virtual SGPath	FindFullPathName (const SGPath &path) const

FGFDMExec *	GetExec (void)

const std::string &	GetName (void)

unsigned int	GetRate (void)
	Get the output rate for the model in frames.

bool	InitModel (void) override

void	SetPropertyManager (std::shared_ptr< 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.

std::string	GetFunctionValues (const std::string &delimeter) const
	Gets the function values.

std::shared_ptr< FGFunction >	GetPreFunction (const std::string &name)
	Get one of the "pre" function.

bool	Load (Element el, FGFDMExec fdmex, std::string prefix="")

void	PostLoad (Element el, FGFDMExec fdmex, std::string prefix="")

void	PreLoad (Element el, FGFDMExec fdmex, 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.

Protected Member Functions
void	Debug (int from) override

Protected Member Functions inherited from FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.

Protected Attributes
bool	enabled

unsigned int	InputIdx

Protected Attributes inherited from FGModel
unsigned int	exe_ctr

FGFDMExec *	FDMExec

std::string	Name

std::shared_ptr< FGPropertyManager >	PropertyManager

unsigned int	rate

Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties

std::vector< std::shared_ptr< FGFunction > >	PostFunctions

std::vector< std::shared_ptr< FGFunction > >	PreFunctions

Additional Inherited Members
Public Types inherited from 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 Public Member Functions inherited from FGJSBBase
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 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 Public Attributes inherited from 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 Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)

Static Protected Attributes inherited from FGJSBBase
static constexpr double	radtodeg = 180. / M_PI

static constexpr double	degtorad = M_PI / 180.

static constexpr double	hptoftlbssec = 550.0

static constexpr double	psftoinhg = 0.014138

static constexpr double	psftopa = 47.88

static constexpr double	fttom = 0.3048

static constexpr double	ktstofps = 1852./(3600*fttom)

static constexpr double	fpstokts = 1.0 / ktstofps

static constexpr double	inchtoft = 1.0/12.0

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__

Constructor & Destructor Documentation

◆ FGInputType()

FGInputType ( FGFDMExec * fdmex )

Constructor (implement the FGModel interface).

Parameters

fdmex a pointer to the parent executive object

Definition at line 50 of file FGInputType.cpp.

                                         :
  FGModel(fdmex), enabled(true)
{
  Debug(0);
}

◆ ~FGInputType()

~FGInputType ( )

override

Destructor.

Definition at line 58 of file FGInputType.cpp.

{
  Debug(1);
}

Member Function Documentation

◆ Debug()

void Debug ( int from )

overrideprotectedvirtual

Reimplemented from FGModel.

Definition at line 131 of file FGInputType.cpp.

{
  if (debug_lvl <= 0) return;
 
  if (debug_lvl & 1) { // Standard console startup message input
    if (from == 0) { // Constructor
 
    }
    if (from == 2) {
    }
  }
  if (debug_lvl & 2 ) { // Instantiation/Destruction notification
    if (from == 0) cout << "Instantiated: FGInputType" << endl;
    if (from == 1) cout << "Destroyed:    FGInputType" << endl;
  }
  if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
  }
  if (debug_lvl & 8 ) { // Runtime state variables
  }
  if (debug_lvl & 16) { // Sanity checking
  }
  if (debug_lvl & 64) {
    if (from == 0) { // Constructor
    }
  }
}

◆ Disable()

void Disable ( void )

inline

Disables the input generation.

Definition at line 114 of file FGInputType.h.

114{ enabled = false; }

◆ Enable()

void Enable ( void )

inline

Enables the input generation.

Definition at line 112 of file FGInputType.h.

112{ enabled = true; }

◆ 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 129 of file FGInputType.h.

129{ return Name; }

◆ InitModel()

bool InitModel ( void )

overridevirtual

Init the input model according to its configitation.

Reimplemented from FGModelFunctions.

Definition at line 88 of file FGInputType.cpp.

{
  bool ret = FGModel::InitModel();
 
  Debug(2);
  return ret;
}

Here is the caller graph for this function:

◆ Load()

bool Load ( Element * el )

overridevirtual

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

Parameters

element XML Element that is pointing to the input directives

Reimplemented from FGModel.

Reimplemented in FGUDPInputSocket.

Definition at line 72 of file FGInputType.cpp.

{
  // Perform base class Load.
  if(!FGModel::Upload(element, true))
    return false;
 
  // no common attributes yet (see FGOutputType for example
 
  // FIXME : PostLoad should be called in the most derived class ?
  PostLoad(element, FDMExec);
 
  return true;
}

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 )

overridevirtual

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 98 of file FGInputType.cpp.

{
  if (FGModel::Run(Holding)) return true;
  if (!enabled) return true;
 
  RunPreFunctions();
  Read(Holding);
  RunPostFunctions();
 
  Debug(4);
 
  return false;
}

Here is the call graph for this function:

◆ SetIdx()

void SetIdx ( unsigned int idx )

Set the idx for this input instance.

Parameters

idx	ID of the input instance that is constructed

Definition at line 65 of file FGInputType.cpp.

{
  InputIdx = idx;
}

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

name new name

Definition at line 125 of file FGInputType.h.

125{ 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 118 of file FGInputType.h.

118{enabled = !enabled; return enabled;}

Member Data Documentation

◆ enabled

bool enabled

protected

Definition at line 133 of file FGInputType.h.

◆ InputIdx

unsigned int InputIdx

protected

Definition at line 132 of file FGInputType.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FGInputType()

◆ ~FGInputType()

Member Function Documentation

◆ Debug()

◆ Disable()

◆ Enable()

◆ GetInputName()

◆ InitModel()

◆ Load()

◆ Read()

◆ Run()

◆ SetIdx()

◆ SetInputName()

◆ Toggle()

Member Data Documentation

◆ enabled

◆ InputIdx