Main namespace for the JSBSim Flight Dynamics Model. More...

Classes
class	aFunc

class	aFunc< func_t, 0 >

class	BaseException

class	BufferLogger

struct	CNumericLocale

class	Element

class	FGAccelerations
	Handles the calculation of accelerations. More...

class	FGAccelerometer
	Encapsulates a Accelerometer component for the flight control system. More...

class	FGActuator
	Encapsulates an Actuator component for the flight control system. More...

class	FGAerodynamics
	Encapsulates the aerodynamic calculations. More...

class	FGAircraft
	Encapsulates an Aircraft and its systems. More...

class	FGAngles
	Provides a way to determine the smallest included angle. More...

class	FGAtmosphere
	Models an empty, abstract base atmosphere class. More...

class	FGAuxiliary
	Encapsulates various uncategorized scheduled functions. More...

class	FGBallonet
	Models a ballonet inside a gas cell. More...

class	FGBrushLessDCMotor

class	FGBuoyantForces
	Encapsulates the Buoyant forces calculations. More...

class	FGColumnVector3
	This class implements a 3 element column vector. More...

class	FGCondition
	Encapsulates a condition, which is used in parts of JSBSim including switches. More...

class	FGDeadBand
	Models a deadband object. More...

class	FGDefaultGroundCallback

class	FGDistributor
	Encapsulates a distributor for the flight control system. More...

class	FGElectric
	Models an electric motor. More...

class	FGEngine
	Base class for all engines. More...

class	FGExternalForce
	Encapsulates code that models an individual arbitrary force, moment or a combination thereof. More...

class	FGExternalReactions
	Manages the external and/or arbitrary forces and moments. More...

class	FGFCS
	Encapsulates the Flight Control System (FCS) functionality. More...

class	FGFCSChannel

class	FGFCSComponent
	Base class for JSBSim Flight Control System Components. More...

class	FGFCSFunction
	Models a FCSFunction object. More...

class	FGFDMExec
	Encapsulates the JSBSim simulation executive. More...

class	FGfdmSocket
	The FGfdmSocket class enables JSBSim to communicate via sockets. More...

class	FGFilter
	Encapsulates a filter for the flight control system. More...

class	FGForce
	Utility class that aids in the conversion of forces between coordinate systems and calculation of moments. More...

class	FGFunction
	Represents a mathematical function. More...

class	FGFunctionValue
	Represents a property value on which a function is applied. More...

class	FGGain
	Encapsulates a gain component for the flight control system. More...

class	FGGasCell
	Models a gas cell. More...

class	FGGroundCallback
	This class provides callback slots to get ground specific data. More...

class	FGGroundReactions
	Manages ground reactions modeling. More...

class	FGGyro
	Encapsulates a Gyro component for the flight control system. More...

class	FGInertial
	Models inertial forces (e.g. More...

class	FGInitialCondition
	Initializes the simulation run. More...

class	FGInput
	Handles simulation input. More...

class	FGInputSocket
	Implements the input from a socket. More...

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

class	FGJSBBase
	JSBSim Base class. More...

class	FGKinemat
	Encapsulates a kinematic (mechanical) component for the flight control system. More...

class	FGLGear
	Landing gear model. More...

class	FGLinearActuator
	Models a flight control system summing component. More...

class	FGLinearization
	Class used to create linear models from FGFDMExec instances. More...

class	FGLocation
	FGLocation holds an arbitrary location in the Earth centered Earth fixed reference frame (ECEF). More...

class	FGLogConsole

class	FGLogger
	Logging backend interface. More...

class	FGLogging

class	FGMagnetometer
	Encapsulates a magnetometer component for the flight control system. More...

class	FGMars
	Models the Martian atmosphere. More...

class	FGMassBalance
	Models weight, balance and moment of inertia information. More...

class	FGMatrix33
	Handles matrix math operations. More...

class	FGModel
	Base class for all scheduled JSBSim models. More...

class	FGModelFunctions
	The model functions class provides the capability for loading, storing, and executing arbitrary functions. More...

class	FGModelLoader

class	FGMSIS
	Models the MSIS-00 atmosphere. More...

class	FGNozzle
	Models a rocket nozzle. More...

class	FGOutput
	Handles simulation output. More...

class	FGOutputFG
	Implements the output to a FlightGear socket. More...

class	FGOutputFile
	Abstract class that provide functions that are generic to all the outputs that are directed to a file. More...

class	FGOutputSocket
	Implements the output to a socket. More...

class	FGOutputTextFile
	Implements the output to a human readable text file. More...

class	FGOutputType
	Abstract class to provide functions generic to all the output directives. More...

class	FGParameter
	Represents various types of parameters. More...

class	FGParameterValue
	Represents a either a real value or a property value. More...

class	FGPID
	Encapsulates a PID control component for the flight control system. More...

class	FGPiston
	Models a Supercharged Piston engine. More...

class	FGPropagate
	Models the EOM and integration/propagation of state. More...

class	FGPropeller
	FGPropeller models a propeller given the tabular data for Ct (thrust) and Cp (power), indexed by the advance ratio "J". More...

class	FGPropertyReader

class	FGPropertyValue
	Represents a property value which can use late binding. More...

class	FGPropertyVector3

class	FGPropulsion
	Propulsion management class. More...

class	FGQuaternion
	Models the Quaternion representation of rotations. More...

class	FGRealValue
	Represents a real value. More...

class	FGRK4
	Classical RK4. More...

class	FGRKFehlberg
	Runge-Kutta-Fehlberg method. More...

class	FGRocket
	Models a generic rocket engine. More...

class	FGRotor
	Models a helicopter rotor. More...

class	FGRungeKutta
	Abstract base. More...

class	FGRungeKuttaProblem
	Minimalistic implementation of some Runge-Kutta methods. More...

class	FGScript
	Encapsulates the JSBSim scripting capability. More...

class	FGSensor
	Encapsulates a Sensor component for the flight control system. More...

class	FGSensorOrientation
	Encapsulates a SensorOrientation capability for a sensor. More...

class	FGSimplifiedTSFC

class	FGSpoolUp

class	FGStandardAtmosphere
	Models the 1976 U.S. More...

class	FGStateSpace

class	FGSummer
	Models a flight control system summing component. More...

class	FGSurface
	Base class for all surface properties. More...

class	FGSwitch
	Encapsulates a switch for the flight control system. More...

class	FGTable
	Lookup table class. More...

class	FGTank
	Models a fuel tank. More...

class	FGTemplateFunc

class	FGThruster
	Base class for specific thrusting devices such as propellers, nozzles, etc. More...

class	FGTransmission
	Utility class that handles power transmission in conjunction with FGRotor. More...

class	FGTrim
	The trimming routine for JSBSim. More...

class	FGTrimAxis

class	FGTurbine
	This class models a turbine engine. More...

class	FGTurboProp
	Turboprop engine model. More...

class	FGUDPInputSocket
	Implements a UDP input socket. More...

class	FGWaypoint
	Models a Waypoint object. More...

class	FGWinds
	Models atmospheric disturbances: winds, gusts, turbulence, downbursts, etc. More...

class	FGXMLFileRead

class	FGXMLLogging

class	FGXMLParse
	Encapsulates an XML parser based on the EasyXML parser from the SimGear library. More...

class	InvalidNumber

struct	LagrangeMultiplier

class	LogException

class	RandomNumberGenerator
	Random number generator. More...

class	TrimFailureException

class	WrongNumberOfArguments

class	XMLLogException

Typedefs
typedef SGSharedPtr< Element >	Element_ptr

typedef std::vector< FGFCSComponent * >	FCSCompVec
	Represents a <channel> in a control system definition.

using	FGLogger_ptr = std::shared_ptr< FGLogger >

typedef SGSharedPtr< FGParameter >	FGParameter_ptr

typedef SGSharedPtr< FGParameterValue >	FGParameterValue_ptr

typedef SGSharedPtr< FGPropertyValue >	FGPropertyValue_ptr

typedef std::shared_ptr< FGTemplateFunc >	FGTemplateFunc_ptr

using	setprecision_t = decltype(std::setprecision(0))

using	setw_t = decltype(std::setw(0))

template<class T >
using	Vector2D = std::vector< std::vector< T > >

Enumerations
enum	altitudeset { setasl , setagl }

enum	Control { tThrottle , tBeta , tAlpha , tElevator , tAileron , tRudder , tAltAGL , tTheta , tPhi , tGamma , tPitchTrim , tRollTrim , tYawTrim , tHeading }

enum	latitudeset { setgeoc , setgeod }

enum class	LogFormat { RESET , RED , BLUE , CYAN , GREEN , DEFAULT , BOLD , NORMAL , UNDERLINE_ON , UNDERLINE_OFF }

enum class	LogLevel { BULK , DEBUG , INFO , WARN , ERROR , FATAL , STDOUT }

enum	OutputForm { ofRad =0 , ofDeg , ofNorm , ofMag , NForms }

enum	speedset { setvt , setvc , setve , setmach , setuvw , setned , setvg }

enum	State { tAll , tUdot , tVdot , tWdot , tQdot , tPdot , tRdot , tHmgt , tNlf }
	Models an aircraft axis for purposes of trimming. More...

enum	TrimMode { tLongitudinal =0 , tFull , tGround , tPullup , tCustom , tTurn , tNone }

Functions
double	atof_locale_c (const string &input)

SGPath	CheckPathName (const SGPath &path, const SGPath &filename)

double	DotProduct (const FGColumnVector3 &v1, const FGColumnVector3 &v2)
	Dot product of two vectors Compute and return the euclidean dot (or scalar) product of two vectors v1 and v2.

unsigned int	FindNumColumns (const string &test_line)

bool	GetBinary (double val, const string &ctxMsg)

string	GetFullyQualifiedName (const SGPropertyNode *node)

FGLogger_ptr	GetLogger (void)
	Returns the active logger for the current thread.

string	GetPrintableName (const SGPropertyNode *node)

string	GetRelativeName (const SGPropertyNode *node, const string &path)

bool	is_number (const std::string &str)

FGFunction *	make_MathFn (double(math_fn)(double), FGFDMExec fdmex, Element el, const string &prefix, FGPropertyValue v)

shared_ptr< RandomNumberGenerator >	makeRandomGenerator (Element el, FGFDMExec fdmex)

double	operator* (const FGParameter_ptr &p, double v)

FGColumnVector3	operator* (double a, const FGPropertyVector3 &v)

FGColumnVector3	operator* (double scalar, const FGColumnVector3 &A)
	Scalar multiplication.

FGLocation	operator* (double scalar, const FGLocation &l)
	Scalar multiplication.

FGMatrix33	operator* (double scalar, const FGMatrix33 &A)
	Scalar multiplication.

FGQuaternion	operator* (double scalar, const FGQuaternion &q)
	Scalar multiplication.

double	operator* (double v, const FGParameter_ptr &p)

ostream &	operator<< (std::ostream &os, const FGColumnVector3 &col)
	Write vector to a stream.

ostream &	operator<< (std::ostream &os, const FGMatrix33 &M)
	Write matrix to a stream.

std::ostream &	operator<< (std::ostream &os, const FGQuaternion &q)
	Write quaternion to a stream.

std::ostream &	operator<< (std::ostream &out, const FGStateSpace &ss)

std::ostream &	operator<< (std::ostream &out, const FGStateSpace::Component &c)

std::ostream &	operator<< (std::ostream &out, const FGStateSpace::ComponentVector &v)

std::ostream &	operator<< (std::ostream &out, const std::vector< double > &vec)

std::ostream &	operator<< (std::ostream &out, const std::vector< std::vector< double > > &vec2d)

istream &	operator>> (std::istream &is, FGMatrix33 &M)
	Read matrix from a stream.

FGQuaternion	QExp (const FGColumnVector3 &omega)
	Quaternion exponential.

std::string	replace (std::string str, const std::string &oldstr, const std::string &newstr)

void	SetLogger (FGLogger_ptr logger)
	Sets the active logger for the current thread.

std::vector< std::string >	split (std::string str, char d)

constexpr double	sqr (double x)
	simply square a value

std::string &	to_lower (std::string &str)

std::string &	to_upper (std::string &str)

std::string &	trim (std::string &str)

std::string &	trim_all_space (std::string &str)

std::string &	trim_left (std::string &str)

std::string &	trim_right (std::string &str)

template<typename func_t >
FGParameter_ptr	VarArgsFn (const func_t &_f, FGFDMExec fdmex, Element el, const string &prefix, FGPropertyValue *v)

Variables
const std::string	ControlNames []

short	debug_lvl

thread_local FGLogger_ptr	GlobalLogger = std::make_shared<FGLogConsole>()

constexpr double	hptowatts = 745.7

const double	invlog2val = 1.0/log10(2.0)

constexpr unsigned int	MaxArgs = 9999

constexpr double	NMtoftpound = 1.3558
	Models an electric brushless DC motor or more appropriately permanent magnet synchronous motor.

const std::string	StateNames []

constexpr double	WattperRPMtoftpound = 60 / (2 * M_PI * NMtoftpound)

Detailed Description

Main namespace for the JSBSim Flight Dynamics Model.

Typedef Documentation

◆ Element_ptr

typedef SGSharedPtr<Element> Element_ptr

Definition at line 137 of file FGXMLElement.h.

◆ FCSCompVec

typedef std::vector<FGFCSComponent*> FCSCompVec

Represents a <channel> in a control system definition.

The <channel> may be defined within a <system>, <autopilot> or <flight_control> element. Channels are a way to group sets of components that perform a specific purpose or algorithm. Created within a <system> tag, the channel is defined as follows <channel name="name" [execute="property"] [execrate="rate"]> name is the name of the channel - in the old way this would also be used to bind elements execute [optional] is the property that defines when to execute this channel; an on/off switch execrate [optional] is the rate at which the channel should execute. A value of 0 or 1 will execute the channel every frame, a value of 2 every other frame (half rate), a value of 4 is every 4th frame (quarter rate)

Definition at line 70 of file FGFCSChannel.h.

◆ FGLogger_ptr

using FGLogger_ptr = std::shared_ptr<FGLogger>

Definition at line 143 of file FGLog.h.

◆ FGParameter_ptr

typedef SGSharedPtr<FGParameter> FGParameter_ptr

Definition at line 72 of file FGParameter.h.

◆ FGParameterValue_ptr

typedef SGSharedPtr<FGParameterValue> FGParameterValue_ptr

Definition at line 107 of file FGParameterValue.h.

◆ FGPropertyValue_ptr

typedef SGSharedPtr<FGPropertyValue> FGPropertyValue_ptr

Definition at line 96 of file FGPropertyValue.h.

◆ FGTemplateFunc_ptr

typedef std::shared_ptr<FGTemplateFunc> FGTemplateFunc_ptr

Definition at line 77 of file FGTemplateFunc.h.

◆ setprecision_t

using setprecision_t = decltype(std::setprecision(0))

Definition at line 60 of file FGLog.h.

◆ setw_t

using setw_t = decltype(std::setw(0))

Definition at line 63 of file FGLog.h.

◆ Vector2D

template<class T >

using Vector2D = std::vector<std::vector<T> >

Definition at line 35 of file FGLinearization.h.

Enumeration Type Documentation

◆ altitudeset

enum altitudeset

Definition at line 71 of file FGInitialCondition.h.

71{ setasl, setagl } altitudeset;

◆ Control

enum Control

Definition at line 83 of file FGTrimAxis.h.

83 { tThrottle, tBeta, tAlpha, tElevator, tAileron, tRudder, tAltAGL,

84 tTheta, tPhi, tGamma, tPitchTrim, tRollTrim, tYawTrim, tHeading };

◆ latitudeset

enum latitudeset

Definition at line 72 of file FGInitialCondition.h.

72{ setgeoc, setgeod } latitudeset;

◆ LogFormat

enum class LogFormat

strong

Definition at line 76 of file FGLog.h.

                     {
  RESET,
  RED,
  BLUE,
  CYAN,
  GREEN,
  DEFAULT,
  BOLD,
  NORMAL,
  UNDERLINE_ON,
  UNDERLINE_OFF
};

◆ LogLevel

enum class LogLevel

strong

Definition at line 66 of file FGLog.h.

                    {
  BULK,  // For frequent messages
  DEBUG, // Less frequent debug type messages
  INFO,  // Informatory messages
  WARN,  // Possible impending problem
  ERROR, // Problem that can be recovered
  FATAL, // Fatal problem => an exception will be thrown
  STDOUT // Standard output - unconditionally displayed.
};

◆ OutputForm

enum OutputForm

Definition at line 57 of file FGFCS.h.

57{ ofRad=0, ofDeg, ofNorm, ofMag , NForms} OutputForm;

◆ speedset

enum speedset

Definition at line 70 of file FGInitialCondition.h.

70{ setvt, setvc, setve, setmach, setuvw, setned, setvg } speedset;

◆ State

enum State

Models an aircraft axis for purposes of trimming.

Definition at line 82 of file FGTrimAxis.h.

82{ tAll,tUdot,tVdot,tWdot,tQdot,tPdot,tRdot,tHmgt,tNlf };

◆ TrimMode

enum TrimMode

Definition at line 67 of file FGTrim.h.

67 { tLongitudinal=0, tFull, tGround, tPullup,

68 tCustom, tTurn, tNone } TrimMode;

Function Documentation

◆ atof_locale_c()

JSBSIM_API double atof_locale_c ( const string & input )

Definition at line 86 of file string_utilities.cpp.

{
  static const std::regex number_format(R"(^\s*[+-]?(\d+(\.\d*)?|\.\d+)([eE][+-]?\d+)?\s*$)");
  const char* first = input.c_str();
 
  // Skip leading whitespaces
  while (isspace(*first)) ++first;
 
  if (!*first)
    throw InvalidNumber("Expecting a numeric attribute value, but only got spaces");
 
  if (!std::regex_match(input, number_format))
    throw InvalidNumber("Expecting a numeric attribute value, but got: " + input);
 
  CNumericLocale numeric_c;
  errno = 0;          // Reset the error code
  double value = strtod_l(first, nullptr, numeric_c.Locale);
 
  // Error management
  std::stringstream s;
 
  if (fabs(value) == HUGE_VAL && errno == ERANGE)
    s << "This number is too large: " << input;
  else if (fabs(value) == 0 && errno == EINVAL)
    s << "Expecting a numeric attribute value, but got: " << input;
  else
    return value;
 
  throw InvalidNumber(s.str());
}

◆ CheckPathName()

SGPath CheckPathName	(	const SGPath &	path,
		const SGPath &	filename
	)

Definition at line 89 of file FGModelLoader.cpp.

                                                                 {
  SGPath fullName = path/filename.utf8Str();
 
  if (fullName.extension() != "xml")
    fullName.concat(".xml");
 
  return fullName.exists() ? fullName : SGPath();
}

◆ DotProduct()

double DotProduct	(	const FGColumnVector3 &	v1,
		const FGColumnVector3 &	v2
	)

inline

Dot product of two vectors Compute and return the euclidean dot (or scalar) product of two vectors v1 and v2.

Definition at line 258 of file FGColumnVector3.h.

                                                                               {
  return v1(1)*v2(1) + v1(2)*v2(2) + v1(3)*v2(3);
}

Here is the caller graph for this function:

◆ FindNumColumns()

unsigned int FindNumColumns ( const string & test_line )

Definition at line 99 of file FGTable.cpp.

{
  // determine number of data columns in table (first column is row lookup - don't count)
  size_t position=0;
  unsigned int nCols=0;
  while ((position = test_line.find_first_not_of(" \t", position)) != string::npos) {
    nCols++;
    position = test_line.find_first_of(" \t", position);
  }
  return nCols;
}

◆ GetBinary()

bool GetBinary	(	double	val,
		const string &	ctxMsg
	)

Definition at line 153 of file FGFunction.cpp.

{
  val = fabs(val);
  if (val < 1E-9) return false;
  else if (val-1 < 1E-9) return true;
  else {
    LogException err;
    err << ctxMsg << LogFormat::RED << LogFormat::BOLD
        << "Malformed conditional check in function definition.\n"
        << LogFormat::RESET;
    throw err;
  }
}

◆ GetFullyQualifiedName()

JSBSIM_API std::string GetFullyQualifiedName ( const SGPropertyNode * node )

Definition at line 117 of file FGPropertyManager.cpp.

{
  string fqname = node->getDisplayName(true);
  const SGPropertyNode* parent = node->getParent();
  if (!parent) return "/";  // node is the root.
 
  while(parent) {
    fqname = parent->getDisplayName(true) + "/" + fqname;
    parent = parent->getParent();
  }
 
  return fqname;
}

◆ GetLogger()

JSBSIM_API FGLogger_ptr GetLogger ( void )

Returns the active logger for the current thread.

See also: SetLogger

Definition at line 52 of file FGLog.cpp.

52{ return GlobalLogger; }

◆ GetPrintableName()

JSBSIM_API std::string GetPrintableName ( const SGPropertyNode * node )

Definition at line 96 of file FGPropertyManager.cpp.

{
  string temp_string(node->getNameString());
  size_t initial_location=0;
  size_t found_location;
 
  found_location = temp_string.rfind("/");
  if (found_location != string::npos)
  temp_string = temp_string.substr(found_location);
 
  found_location = temp_string.find('_',initial_location);
  while (found_location != string::npos) {
    temp_string.replace(found_location,1," ");
    initial_location = found_location+1;
    found_location = temp_string.find('_',initial_location);
  }
  return temp_string;
}

◆ GetRelativeName()

JSBSIM_API std::string GetRelativeName	(	const SGPropertyNode *	node,
		const string &	path
	)

Definition at line 133 of file FGPropertyManager.cpp.

{
  string temp_string = GetFullyQualifiedName(node);
  size_t len = path.length();
  if ( (len > 0) && (temp_string.substr(0,len) == path) ) {
    temp_string = temp_string.erase(0,len);
  }
  return temp_string;
}

◆ is_number()

JSBSIM_API bool is_number ( const std::string & str )

Definition at line 164 of file string_utilities.cpp.

{
  try {
    atof_locale_c(str);
  } catch (InvalidNumber&) {
    return false;
  }
 
  return true;
}

◆ make_MathFn()

FGFunction * make_MathFn	(	double(*)(double)	math_fn,
		FGFDMExec *	fdmex,
		Element *	el,
		const string &	prefix,
		FGPropertyValue *	v
	)

Definition at line 171 of file FGFunction.cpp.

{
  auto f = [math_fn](const std::vector<FGParameter_ptr> &p)->double {
             return math_fn(p[0]->GetValue());
           };
  return new aFunc<decltype(f), 1>(f, fdmex, el, prefix, v);
}

◆ makeRandomGenerator()

shared_ptr< RandomNumberGenerator > makeRandomGenerator	(	Element *	el,
		FGFDMExec *	fdmex
	)

Definition at line 300 of file FGFunction.cpp.

{
  string seed_attr = el->GetAttributeValue("seed");
  if (seed_attr.empty())
    return fdmex->GetRandomGenerator();
  else if (seed_attr == "time_now")
    return make_shared<RandomNumberGenerator>();
  else {
    unsigned int seed = atoi(seed_attr.c_str());
    return make_shared<RandomNumberGenerator>(seed);
  }
}

◆ operator*() [1/7]

double operator*	(	const FGParameter_ptr &	p,
		double	v
	)

inline

Definition at line 78 of file FGParameter.h.

                                                            {
  return p->GetValue()*v;
}

◆ operator*() [2/7]

FGColumnVector3 operator*	(	double	a,
		const FGPropertyVector3 &	v
	)

inline

Definition at line 89 of file FGExternalForce.h.

                                                                       {
  return v*a;
}

◆ operator*() [3/7]

FGColumnVector3 operator*	(	double	scalar,
		const FGColumnVector3 &	A
	)

inline

Scalar multiplication.

Parameters

scalar	scalar value to multiply with.
A	Vector to multiply. Multiply the Vector with a scalar value. Note: At this time, this operator MUST be inlined, or a multiple definition link error will occur.

Definition at line 267 of file FGColumnVector3.h.

                                                                          {
  // use already defined operation.
  return A*scalar;
}

◆ operator*() [4/7]

FGLocation operator*	(	double	scalar,
		const FGLocation &	l
	)

inline

Scalar multiplication.

Parameters

scalar	scalar value to multiply with.
l	Vector to multiply.

Multiply the Vector with a scalar value.

Definition at line 542 of file FGLocation.h.

{
  return l.operator*(scalar);
}

◆ operator*() [5/7]

FGMatrix33 operator*	(	double	scalar,
		const FGMatrix33 &	A
	)

inline

Scalar multiplication.

Parameters

scalar	scalar value to multiply with.
A	Matrix to multiply.

Multiply the Matrix with a scalar value.

Definition at line 444 of file FGMatrix33.h.

                                                                {
  // use already defined operation.
  return A*scalar;
}

◆ operator*() [6/7]

FGQuaternion operator*	(	double	scalar,
		const FGQuaternion &	q
	)

inline

Scalar multiplication.

Parameters

scalar	scalar value to multiply with.
q	Vector to multiply.

Multiply the Vector with a scalar value.

Definition at line 539 of file FGQuaternion.h.

                                                                    {
  return FGQuaternion(scalar*q.data[0], scalar*q.data[1], scalar*q.data[2], scalar*q.data[3]);
}

◆ operator*() [7/7]

double operator*	(	double	v,
		const FGParameter_ptr &	p
	)

inline

Definition at line 74 of file FGParameter.h.

                                                            {
  return v*p->GetValue();
}

◆ operator<<() [1/8]

JSBSIM_API std::ostream & operator<<	(	std::ostream &	os,
		const FGColumnVector3 &	col
	)

Write vector to a stream.

Parameters

os	Stream to write to.
col	vector to write. Write the vector to a stream.

Definition at line 76 of file FGColumnVector3.cpp.

{
  os << col(1) << " , " << col(2) << " , " << col(3);
  return os;
}

Here is the caller graph for this function:

◆ operator<<() [2/8]

JSBSIM_API std::ostream & operator<<	(	std::ostream &	os,
		const FGMatrix33 &	M
	)

Write matrix to a stream.

Parameters

os	Stream to write to.
M	Matrix to write.

Write the matrix to a stream.

Definition at line 194 of file FGMatrix33.cpp.

{
  for (unsigned int i=1; i<=M.Rows(); i++) {
    for (unsigned int j=1; j<=M.Cols(); j++) {
      if (i == M.Rows() && j == M.Cols())
        os << M(i,j);
      else
        os << M(i,j) << ", ";
    }
  }
  return os;
}

Here is the call graph for this function:

◆ operator<<() [3/8]

JSBSIM_API std::ostream & operator<<	(	std::ostream &	os,
		const FGQuaternion &	q
	)

Write quaternion to a stream.

Parameters

os	Stream to write to.
q	Quaternion to write. Write the quaternion to a stream.

Definition at line 248 of file FGQuaternion.cpp.

{
  os << q(1) << " , " << q(2) << " , " << q(3) << " , " << q(4);
  return os;
}

◆ operator<<() [4/8]

std::ostream & operator<<	(	std::ostream &	out,
		const FGStateSpace &	ss
	)

Definition at line 135 of file FGStateSpace.cpp.

{
    out << "\nX:\n" << ss.x
    << "\nU:\n" << ss.u
    << "\nY:\n" << ss.y;
    return out;
}

◆ operator<<() [5/8]

std::ostream & operator<<	(	std::ostream &	out,
		const FGStateSpace::Component &	c
	)

Definition at line 117 of file FGStateSpace.cpp.

{
    out << "\t" << c.getName()
    << "\t" << c.getUnit()
    << "\t:\t" << c.get();
    return out;
}

◆ operator<<() [6/8]

std::ostream & operator<<	(	std::ostream &	out,
		const FGStateSpace::ComponentVector &	v
	)

Definition at line 125 of file FGStateSpace.cpp.

{
    for (unsigned int i=0; i< v.getSize(); i++)
    {
        out << *(v.getComp(i)) << "\n";
    }
    out << "";
    return out;
}

◆ operator<<() [7/8]

std::ostream & operator<<	(	std::ostream &	out,
		const std::vector< double > &	vec
	)

Definition at line 171 of file FGStateSpace.cpp.

{
    std::streamsize width = out.width();
    size_t nI = vec.size();
    out << std::left << std::setw(1) << "[" << std::right;
    for (unsigned int i=0;i<nI;i++)
    {
        if (i==0) out << std::setw(width-1) << vec[i];
        else out << std::setw(width) << vec[i];
 
        if ( i==nI-1 ) out << "]";
        else out <<  ";\n";
    }
    out << std::flush;
    return out;
}

◆ operator<<() [8/8]

std::ostream & operator<<	(	std::ostream &	out,
		const std::vector< std::vector< double > > &	vec2d
	)

Definition at line 143 of file FGStateSpace.cpp.

{
    std::streamsize width = out.width();
    size_t nI = vec2d.size();
    out << std::left << std::setw(1) << "[" << std::right;
    for (unsigned int i=0;i<nI;i++)
    {
        //FGLogging log(LogLevel::DEBUG);
    //log << "i: " << i << "\n";
        size_t nJ = vec2d[i].size();
        for (unsigned int j=0;j<nJ;j++)
        {
      //log << "j: " << j << "\n";
            if (i==0 && j==0) out << std::setw(width-1) << vec2d[i][j];
            else out << std::setw(width) << vec2d[i][j];
 
            if (j==nJ-1)
            {
                if ( i==nI-1 ) out << "]";
                else out <<  ";\n";
            }
            else out << ",";
        }
        out << std::flush;
    }
    return out;
}

◆ operator>>()

JSBSIM_API std::istream & operator>>	(	std::istream &	is,
		FGMatrix33 &	M
	)

Read matrix from a stream.

Parameters

os	Stream to read from.
M	Matrix to initialize with the values from the stream.

Read matrix from a stream.

Definition at line 209 of file FGMatrix33.cpp.

{
  for (unsigned int i=1; i<=M.Rows(); i++) {
    for (unsigned int j=1; j<=M.Cols(); j++) {
      is >> M(i,j);
    }
  }
  return is;
}

Here is the call graph for this function:

◆ QExp()

FGQuaternion QExp ( const FGColumnVector3 & omega )

inline

Quaternion exponential.

Parameters

omega rotation velocity Calculate the unit quaternion which is the result of the exponentiation of the vector 'omega'.

Definition at line 548 of file FGQuaternion.h.

                                                       {
  FGQuaternion qexp;
  double angle = omega.Magnitude();
  double sina_a = angle > 0.0 ? sin(angle)/angle : 1.0;
 
  qexp.data[0] = cos(angle);
  qexp.data[1] = omega(1) * sina_a;
  qexp.data[2] = omega(2) * sina_a;
  qexp.data[3] = omega(3) * sina_a;
 
  return qexp;
}

◆ replace()

JSBSIM_API std::string replace	(	std::string	str,
		const std::string &	oldstr,
		const std::string &	newstr
	)

Definition at line 198 of file string_utilities.cpp.

{
  std::string temp = str;
  size_t old_idx = str.find(oldstr);
  if (old_idx != std::string::npos) {
    temp = str.replace(old_idx, 1, newstr);
  }
  return temp;
}

◆ SetLogger()

JSBSIM_API void SetLogger ( FGLogger_ptr logger )

Sets the active logger for the current thread.

The logger is stored in thread-local storage: all JSBSim instances running in this thread share this same FGLogger instance, while other threads keep their own independent logger instance.

See also: GetLogger

Definition at line 51 of file FGLog.cpp.

51{ GlobalLogger = logger; }

◆ split()

JSBSIM_API std::vector< std::string > split	(	std::string	str,
		char	d
	)

Definition at line 175 of file string_utilities.cpp.

{
  std::vector <std::string> str_array;
  size_t index=0;
  std::string temp = "";
 
  trim(str);
  index = str.find(d);
  while (index != std::string::npos) {
    temp = str.substr(0,index);
    trim(temp);
    if (!temp.empty()) str_array.push_back(temp);
    str = str.erase(0,index+1);
    index = str.find(d);
  }
  if (!str.empty()) {
    temp = trim(str);
    if (!temp.empty()) str_array.push_back(temp);
  }
 
  return str_array;
}

◆ sqr()

static double sqr ( double x )

inlineconstexpr

simply square a value

Definition at line 73 of file FGWinds.cpp.

73{ return x*x; }

◆ to_lower()

JSBSIM_API std::string & to_lower ( std::string & str )

Definition at line 158 of file string_utilities.cpp.

{
  for (size_t i=0; i<str.size(); i++) str[i] = tolower(str[i]);
  return str;
}

◆ to_upper()

JSBSIM_API std::string & to_upper ( std::string & str )

Definition at line 152 of file string_utilities.cpp.

{
  for (size_t i=0; i<str.size(); i++) str[i] = toupper(str[i]);
  return str;
}

◆ trim()

JSBSIM_API std::string & trim ( std::string & str )

Definition at line 134 of file string_utilities.cpp.

{
  if (str.empty()) return str;
  std::string temp_str = trim_right(str);
  return str = trim_left(temp_str);
}

◆ trim_all_space()

JSBSIM_API std::string & trim_all_space ( std::string & str )

Definition at line 141 of file string_utilities.cpp.

{
  for (size_t i=0; i<str.size(); i++) {
    if (isspace((unsigned char)str[i])) {
      str = str.erase(i,1);
      --i;
    }
  }
  return str;
}

◆ trim_left()

JSBSIM_API std::string & trim_left ( std::string & str )

Definition at line 118 of file string_utilities.cpp.

{
  while (!str.empty() && isspace((unsigned char)str[0])) {
    str = str.erase(0,1);
  }
  return str;
}

◆ trim_right()

JSBSIM_API std::string & trim_right ( std::string & str )

Definition at line 126 of file string_utilities.cpp.

{
  while (!str.empty() && isspace((unsigned char)str[str.size()-1])) {
    str = str.erase(str.size()-1,1);
  }
  return str;
}

◆ VarArgsFn()

template<typename func_t >

FGParameter_ptr VarArgsFn	(	const func_t &	_f,
		FGFDMExec *	fdmex,
		Element *	el,
		const string &	prefix,
		FGPropertyValue *	v
	)

Definition at line 186 of file FGFunction.cpp.

{
  try {
    return new aFunc<func_t, 2>(_f, fdmex, el, prefix, v, MaxArgs);
  }
  catch(WrongNumberOfArguments& e) {
    if ((e.GetElement() == el) && (e.NumberOfArguments() == 1)) {
      FGXMLLogging log(el, LogLevel::WARN);
      log << LogFormat::RED
          << "<" << el->GetName()
          << "> only has one argument which makes it a no-op.\n"
          << "Its argument will be evaluated but <" << el->GetName()
          << "> will not be applied to the result.\n" << LogFormat::RESET;
      return e.FirstParameter();
    }
    else
      throw e;
  }
}

Variable Documentation

◆ ControlNames

const std::string ControlNames[]

Initial value:

=  { "Throttle","Sideslip","Angle of Attack",
                                      "Elevator","Ailerons","Rudder",
                                      "Altitude AGL", "Pitch Angle",
                                      "Roll Angle", "Flight Path Angle", 
                                      "Pitch Trim", "Roll Trim", "Yaw Trim",
                                      "Heading"
                                    }

Definition at line 60 of file FGTrimAxis.h.

                                  { "Throttle","Sideslip","Angle of Attack",
                                      "Elevator","Ailerons","Rudder",
                                      "Altitude AGL", "Pitch Angle",
                                      "Roll Angle", "Flight Path Angle", 
                                      "Pitch Trim", "Roll Trim", "Yaw Trim",
                                      "Heading"
                                    };

◆ GlobalLogger

thread_local FGLogger_ptr GlobalLogger = std::make_shared<FGLogConsole>()

Definition at line 49 of file FGLog.cpp.

◆ hptowatts

constexpr double hptowatts = 745.7

constexpr

Definition at line 74 of file FGBrushLessDCMotor.h.

◆ invlog2val

const double invlog2val = 1.0/log10(2.0)

Definition at line 52 of file FGFunction.cpp.

◆ MaxArgs

constexpr unsigned int MaxArgs = 9999

constexpr

Definition at line 53 of file FGFunction.cpp.

◆ NMtoftpound

constexpr double NMtoftpound = 1.3558

constexpr

Models an electric brushless DC motor or more appropriately permanent magnet synchronous motor.

as alternative to basic electric motor. BLDC motor code is based on basic "3 constant motor equations" It require 3 basic physical motor properties (available from manufactures): Kv speed motor constant [RPM/Volt] Rm internal coil resistance [Ohms] I0 no load current [Amperes] additional inputs : maxvolts nominal voltage from battery

Input format : <brushless_dc_motor> <maxvolts units="VOLTS"> {number} </maxvolts> <velocityconstant units="RPM/V"> {number} </velocityconstant> <coilresistance units="OHMS"> {number} </coilresistance> <noloadcurrent units="AMPERES"> {number} </noloadcurrent> </brushless_dc_motor>

Definition at line 73 of file FGBrushLessDCMotor.h.

◆ StateNames

const std::string StateNames[]

Initial value:

=   { "all","udot","vdot","wdot","qdot","pdot",
                                     "rdot","hmgt","nlf" 
                                   }

Definition at line 57 of file FGTrimAxis.h.

                                 { "all","udot","vdot","wdot","qdot","pdot",
                                     "rdot","hmgt","nlf" 
                                   };

◆ WattperRPMtoftpound

constexpr double WattperRPMtoftpound = 60 / (2 * M_PI * NMtoftpound)

constexpr

Definition at line 75 of file FGBrushLessDCMotor.h.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ Element_ptr

◆ FCSCompVec

◆ FGLogger_ptr

◆ FGParameter_ptr

◆ FGParameterValue_ptr

◆ FGPropertyValue_ptr

◆ FGTemplateFunc_ptr

◆ setprecision_t

◆ setw_t

◆ Vector2D

Enumeration Type Documentation

◆ altitudeset

◆ Control

◆ latitudeset

◆ LogFormat

◆ LogLevel

◆ OutputForm

◆ speedset

◆ State

◆ TrimMode

Function Documentation

◆ atof_locale_c()

◆ CheckPathName()

◆ DotProduct()

◆ FindNumColumns()

◆ GetBinary()

◆ GetFullyQualifiedName()

◆ GetLogger()

◆ GetPrintableName()

◆ GetRelativeName()

◆ is_number()

◆ make_MathFn()

◆ makeRandomGenerator()

◆ operator*() [1/7]

◆ operator*() [2/7]

◆ operator*() [3/7]

◆ operator*() [4/7]

◆ operator*() [5/7]

◆ operator*() [6/7]

◆ operator*() [7/7]

◆ operator<<() [1/8]

◆ operator<<() [2/8]

◆ operator<<() [3/8]

◆ operator<<() [4/8]

◆ operator<<() [5/8]

◆ operator<<() [6/8]

◆ operator<<() [7/8]

◆ operator<<() [8/8]

◆ operator>>()

◆ QExp()

◆ replace()

◆ SetLogger()

◆ split()

◆ sqr()

◆ to_lower()

◆ to_upper()

◆ trim()

◆ trim_all_space()

◆ trim_left()

◆ trim_right()

◆ VarArgsFn()

Variable Documentation

◆ ControlNames

◆ GlobalLogger

◆ hptowatts

◆ invlog2val

◆ MaxArgs

◆ NMtoftpound

◆ StateNames

◆ WattperRPMtoftpound