FGInput Class Reference

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:

<input type="SOCKET" port="4321"/>

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.

#include <FGInput.h>

Inheritance diagram for FGInput:

Collaboration diagram for FGInput:

Public Member Functions
	FGInput (FGFDMExec *)
void	Disable (void)
	Disables the input generation for all input instances.
void	Enable (void)
	Enables the input generation for all input instances.
std::string	GetInputName (unsigned int idx) const
	Get the name identifier to which the input will be directed.
bool	InitModel (void) override
	Initializes the instance.
bool	Load (Element *el) override
	Load the input directives and adds a new input instance to the Input Manager list.
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.
bool	SetInputName (unsigned int idx, const std::string &name)
	Overwrites the name identifier under which the input will be logged.
bool	Toggle (int idx)
	Toggles the input generation of each input instance.
Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *, const std::string &name)
	Constructor.
	~FGModel () override
	Destructor.
virtual SGPath	FindFullPathName (const SGPath &path) const
FGFDMExec *	GetExec (void) const
const std::string &	GetName (void) const
unsigned int	GetRate (void) const
	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.

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 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	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine.
static constexpr 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.
static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison.
static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison.
static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison.
static constexpr double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius.
static constexpr double	FeetToMeters (double measure)
	Converts from feet to meters.
static const std::string &	GetVersion (void)
	Returns the version number of JSBSim.
static constexpr double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius.
static constexpr double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit.
static constexpr double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine.
static constexpr double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius.
static constexpr double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin.
static constexpr double	sign (double num)
Static Public Attributes inherited from FGJSBBase
static short	debug_lvl = 1
Protected Member Functions inherited from FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.
Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)
Protected Attributes inherited from FGModel
bool	enabled = true
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
Static Protected Attributes inherited from FGJSBBase
static constexpr double	degtorad = M_PI / 180.
static constexpr double	fpstokts = 1.0 / ktstofps
static constexpr double	fttom = 0.3048
static constexpr double	hptoftlbssec = 550.0
static constexpr double	in3tom3 = inchtoft*inchtoft*inchtoft/m3toft3
static constexpr double	inchtoft = 1.0/12.0
static constexpr double	inhgtopa = 3386.38
static const std::string	JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__
static constexpr double	kgtolb = 2.20462
static constexpr double	kgtoslug = 0.06852168
static constexpr double	ktstofps = 1852./(3600*fttom)
static constexpr double	lbtoslug = 1.0/slugtolb
static constexpr double	m3toft3 = 1.0/(fttom*fttom*fttom)
static const std::string	needed_cfg_version = "2.0"
static constexpr double	psftoinhg = 0.014138
static constexpr double	psftopa = 47.88
static constexpr double	radtodeg = 180. / M_PI
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.

Constructor & Destructor Documentation

FGInput()

FGInput

(

FGFDMExec *

fdmex

)

Definition at line 57 of file FGInput.cpp.

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

~FGInput()

~FGInput ( )

override

Definition at line 66 of file FGInput.cpp.

{
  vector<FGInputType*>::iterator it;
  for (it = InputTypes.begin(); it != InputTypes.end(); ++it)
    delete (*it);
 
  Debug(1);
}

Member Function Documentation

Disable()

void Disable

(

void

)

Disables the input generation for all input instances.

Definition at line 215 of file FGInput.cpp.

{
  enabled = false;
  for (auto input : InputTypes)
    input->Disable();
}

Enable()

void Enable

(

void

)

Enables the input generation for all input instances.

Definition at line 207 of file FGInput.cpp.

{
  enabled = true;
  for (auto input : InputTypes)
    input->Enable();
}

GetInputName()

string 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 195 of file FGInput.cpp.

{
  string name;
 
  if (idx < InputTypes.size())
    name = InputTypes[idx]->GetInputName();
  return name;
}

InitModel()

bool 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 FGModelFunctions.

Definition at line 125 of file FGInput.cpp.

{
  bool ret = false;
 
  if (!FGModel::InitModel()) return false;
 
  vector<FGInputType*>::iterator it;
  for (it = InputTypes.begin(); it != InputTypes.end(); ++it)
    ret &= (*it)->InitModel();
 
  return ret;
}

Load()

bool 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 FGModel.

Definition at line 77 of file FGInput.cpp.

{
  // Unlike the other FGModel classes, properties listed in the <input> section
  // are not intended to create new properties. For that reason, FGInput
  // cannot load its XML directives with FGModel::Load().
  // Instead FGModelLoader::Open() and FGModel::PreLoad() must be explicitely
  // called.
  FGModelLoader ModelLoader(this);
  Element* element = ModelLoader.Open(el);
 
  if (!element) return false;
 
  FGModel::PreLoad(element, FDMExec);
 
  size_t idx = InputTypes.size();
  string type = element->GetAttributeValue("type");
  FGInputType* Input = 0;
 
  if (debug_lvl > 0) {
    FGLogging log(LogLevel::DEBUG);
    log << endl << "  Input data set: " << idx << "  " << endl;
  }
 
  type = to_upper(type);
 
  if (type.empty() || type == "SOCKET") {
    Input = new FGInputSocket(FDMExec, enabled);
  } else if (type == "QTJSBSIM") {
    Input = new FGUDPInputSocket(FDMExec, enabled);
  } else if (type != string("NONE")) {
    FGXMLLogging log(element, LogLevel::ERROR);
    log << "Unknown type of input specified in config file" << endl;
  }
 
  if (!Input) return false;
 
  Input->SetIdx(idx);
  Input->Load(element);
  PostLoad(element, FDMExec);
 
  InputTypes.push_back(Input);
 
  Debug(2);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Run()

bool 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 FGModel.

Definition at line 140 of file FGInput.cpp.

{
  if (FDMExec->GetTrimStatus()) return true;
  if (FGModel::Run(Holding)) return true;
 
  vector<FGInputType*>::iterator it;
  for (it = InputTypes.begin(); it != InputTypes.end(); ++it)
    (*it)->Run(Holding);
 
  return false;
}

SetDirectivesFile()

bool 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 154 of file FGInput.cpp.

{
  FGXMLFileRead XMLFile;
  Element* document = XMLFile.LoadXMLDocument(fname);
  if (!document) {
    LogException err;
    err << "Could not read directive file: " << fname << endl;
    throw err;
  }
  bool result = Load(document);
 
  if (!result) {
    FGLogging log(LogLevel::ERROR);
    log << endl << "Aircraft input element has problems in file " << fname << endl;
  }
 
  return result;
}

SetInputName()

bool 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 185 of file FGInput.cpp.

{
  if (idx >= InputTypes.size()) return false;
 
  InputTypes[idx]->SetInputName(name);
  return true;
}

Toggle()

bool 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 175 of file FGInput.cpp.

{
  if (idx >= (int)0 && idx < (int)InputTypes.size())
    return InputTypes[idx]->Toggle();
 
  return false;
}

---

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

• FGInput.h
• FGInput.cpp