Detailed Description

Base class for all scheduled JSBSim models.

Each model binds simulation/models/<Name>/enabled (default true), where Name is the name passed to the constructor. Setting that property false skips the model's Run(): its last state and its property bindings are preserved, which is the property-tree mechanism by which an external system can replace a model, for example a host physics engine owning FGGroundReactions. The binding is made at construction, so a model that renames itself while loading does not move its enable property.

Author: Jon S. Berndt

Definition at line 78 of file FGModel.h.

#include <FGModel.h>

Inheritance diagram for FGModel:

Collaboration diagram for FGModel:

Public Member Functions
	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

virtual bool	Load (Element *el)

virtual bool	Run (bool Holding)
	Runs the model; called by the Executive.

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.

Protected Member Functions
virtual void	Debug (int from)

bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.

Protected Attributes
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

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

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

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

◆ FGModel()

FGModel	(	FGFDMExec *	fdmex,
		const std::string &	name
	)

Constructor.

Parameters

name	the name of this model. It populates the member Name and binds simulation/models/<name>/enabled.

Definition at line 59 of file FGModel.cpp.

 : Name(name)
{
  FDMExec     = fdmex;
 
  //in order for FGModel derived classes to self-bind (that is, call
  //their bind function in the constructor, the PropertyManager pointer
  //must be brought up now.
  PropertyManager = FDMExec->GetPropertyManager();
 
  exe_ctr     = 1;
  rate        = 1;
 
  // A model that is scheduled by FGFDMExec is named and gets an enable property.
  // The input and output types are not scheduled: they are instantiated one per
  // <input> and <output> element, so a shared property path would be tied more
  // than once. They pass an empty name and are enabled through the per-instance
  // property that FGOutputType::SetIdx already binds, or through Enable() and
  // Disable().
  if (!Name.empty())
    PropertyManager->Tie("simulation/models/" + Name + "/enabled", &enabled);
 
  Debug(0);
}

Here is the call graph for this function:

◆ ~FGModel()

~FGModel ( )

override

Destructor.

Definition at line 86 of file FGModel.cpp.

{
  Debug(1);
}

Member Function Documentation

◆ Debug()

void Debug ( int from )

protectedvirtual

Definition at line 183 of file FGModel.cpp.

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

◆ FindFullPathName()

SGPath FindFullPathName ( const SGPath & path ) const

virtual

Definition at line 116 of file FGModel.cpp.

{
  return CheckPathName(FDMExec->GetFullAircraftPath(), path);
}

◆ GetExec()

FGFDMExec * GetExec ( void ) const

inline

Definition at line 105 of file FGModel.h.

105{ return FDMExec; }

◆ GetName()

const std::string & GetName ( void ) const

inline

Definition at line 109 of file FGModel.h.

109{ return Name; }

◆ GetRate()

unsigned int GetRate ( void ) const

inline

Get the output rate for the model in frames.

Definition at line 104 of file FGModel.h.

104{ return rate; }

◆ InitModel()

bool InitModel ( void )

overridevirtual

Reimplemented from FGModelFunctions.

Reimplemented in FGPropagate, FGOutputFile, FGOutputSocket, FGOutputType, FGMSIS, and FGOutput.

Definition at line 93 of file FGModel.cpp.

{
  exe_ctr = 1;
  return FGModelFunctions::InitModel();
}

◆ Load()

virtual bool Load ( Element * el )

inlinevirtual

Reimplemented in FGOutputFG, FGInputSocket, FGInputType, FGOutputFile, FGOutputSocket, FGOutputTextFile, FGOutputType, FGUDPInputSocket, FGAircraft, FGExternalReactions, FGFCS, FGInput, FGPropulsion, FGAerodynamics, and FGBuoyantForces.

Definition at line 110 of file FGModel.h.

110{ return true; }

◆ Run()

bool Run ( bool Holding )

virtual

Runs the 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. The Holding flag is not used in the base FGModel class.

See also: JSBSim.cpp documentation

Returns: false if no error

Reimplemented in FGPropagate, FGInputType, FGOutputType, FGWinds, FGAccelerations, FGAerodynamics, FGAircraft, FGAtmosphere, FGAuxiliary, FGBuoyantForces, FGExternalReactions, FGFCS, FGGroundReactions, FGInertial, FGInput, FGMassBalance, FGOutput, and FGPropulsion.

Definition at line 101 of file FGModel.cpp.

{
  FGModel::Debug(2);
 
  if (rate == 1) return !enabled; // Fast exit if nothing to do
 
  if (exe_ctr >= rate) exe_ctr = 0;
 
  if (exe_ctr++ == 1) return !enabled;
 
  return true;
}

Here is the caller graph for this function:

◆ SetPropertyManager()

void SetPropertyManager ( std::shared_ptr< FGPropertyManager > fgpm )

inline

Definition at line 107 of file FGModel.h.

107{ PropertyManager=fgpm;}

◆ SetRate()

void SetRate ( unsigned int tt )

inline

Set the ouput rate for the model in frames.

Definition at line 102 of file FGModel.h.

102{rate = tt;}

Here is the caller graph for this function:

◆ Upload()

bool Upload	(	Element *	el,
		bool	preLoad
	)

protected

Uploads this model in memory.

Uploads the model in memory if its contents are contained in a separate file.

Parameters

el	a pointer to the element
preLoad	true if model functions and local properties must be preloaded.

Returns: true if model is successfully loaded

Definition at line 123 of file FGModel.cpp.

{
  FGModelLoader ModelLoader(this);
  Element* document = ModelLoader.Open(el);
 
  if (!document) return false;
 
  if (document->GetName() != el->GetName()) {
    FGXMLLogging log(el, LogLevel::ERROR);
    log << " Read model '" << document->GetName()
        << "' while expecting model '" << el->GetName() << "'" << endl;
    return false;
  }
 
  bool result = true;
 
  if (preLoad)
    result = FGModelFunctions::Load(document, FDMExec);
 
  if (document != el) {
    el->MergeAttributes(document);
 
    if (preLoad) {
      // After reading interface properties in a file, read properties in the
      // local model element. This allows general-purpose models to be defined
      // in a file, with overrides or initial loaded constants supplied in the
      // relevant element of the aircraft configuration file.
      LocalProperties.Load(el, PropertyManager.get(), true);
    }
 
    Element* element = document->FindElement();
    while (element) {
      el->AddChildElement(element);
      element->SetParent(el);
      element = document->FindNextElement();
    }
  }
 
  return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ enabled

bool enabled = true

protected

Definition at line 115 of file FGModel.h.

◆ exe_ctr

unsigned int exe_ctr

protected

Definition at line 113 of file FGModel.h.

◆ FDMExec

FGFDMExec* FDMExec

protected

Definition at line 129 of file FGModel.h.

◆ Name

std::string Name

protected

Definition at line 116 of file FGModel.h.

◆ PropertyManager

std::shared_ptr<FGPropertyManager> PropertyManager

protected

Definition at line 130 of file FGModel.h.

◆ rate

unsigned int rate

protected

Definition at line 114 of file FGModel.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

◆ FGModel()

◆ ~FGModel()

Member Function Documentation

◆ Debug()

◆ FindFullPathName()

◆ GetExec()

◆ GetName()

◆ GetRate()

◆ InitModel()

◆ Load()

◆ Run()

◆ SetPropertyManager()

◆ SetRate()

◆ Upload()

Member Data Documentation

◆ enabled

◆ exe_ctr

◆ FDMExec

◆ Name

◆ PropertyManager

◆ rate