FGOutputFG Class Reference

Detailed Description

Implements the output to a FlightGear socket.

Definition at line 63 of file FGOutputFG.h.

#include <FGOutputFG.h>

Inheritance diagram for FGOutputFG:

Collaboration diagram for FGOutputFG:

Public Member Functions
	FGOutputFG (FGFDMExec *fdmex)
	Constructor.
bool	Load (Element *) override
	Evaluate the output directives from an XML file.
void	Print (void) override
	Generate the output.
Public Member Functions inherited from FGOutputSocket
	FGOutputSocket (FGFDMExec *fdmex)
	Constructor.
	~FGOutputSocket () override
	Destructor.
bool	InitModel (void) override
	Initializes the instance.
bool	Load (Element *el) override
	Init the output directives from an XML file.
void	Print (void) override
	Generates the output.
void	SetOutputName (const std::string &name) override
	Overwrites the name identifier under which the output will be logged.
void	SocketStatusOutput (const std::string &out_str)
	Outputs a status thru the socket.
Public Member Functions inherited from FGOutputType
	FGOutputType (FGFDMExec *fdmex)
	Constructor (implement the FGModel interface).
	~FGOutputType () override
	Destructor.
void	Disable (void)
	Disables the output generation.
void	Enable (void)
	Enables the output generation.
virtual const std::string &	GetOutputName (void) const
	Get the name identifier to which the output will be directed.
double	GetRateHz (void) const
	Get the output rate in Hz for this output.
bool	InitModel (void) override
	Init the output model according to its configitation.
bool	Load (Element *el) override
	Init the output directives from an XML file (implement the FGModel interface).
bool	Run (bool Holding) override
	Executes the output directives (implement the FGModel interface).
void	SetIdx (unsigned int idx)
	Set the idx for this output instance.
void	SetOutputProperties (std::vector< FGPropertyNode_ptr > &outputProperties)
	Set the list of properties that should be output for this output instance.
void	SetRateHz (double rtHz)
	Set the output rate for this output instances.
virtual void	SetStartNewOutput (void)
	Reset the output prior to a restart of the simulation.
void	SetSubSystems (int subSystems)
	Set the activated subsystems for this output instance.
bool	Toggle (void)
	Toggles the output 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.
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	PrintHeaders (void) override
Protected Member Functions inherited from FGOutputType
void	Debug (int from) override
Protected Member Functions inherited from FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.

Additional Inherited Members
Public Types inherited from FGOutputType
enum	eSubSystems {   ssSimulation = 1 , ssAerosurfaces = 2 , ssRates = 4 , ssVelocities = 8 ,   ssForces = 16 , ssMoments = 32 , ssAtmosphere = 64 , ssMassProps = 128 ,   ssAeroFunctions = 256 , ssPropagate = 512 , ssGroundReactions = 1024 , ssFCS = 2048 ,   ssPropulsion = 4096 }
	Subsystem types for specifying which will be output in the FDM data logging. More...
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)
Public Attributes inherited from FGOutputType
enum JSBSim::FGOutputType::eSubSystems	subsystems
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)
Protected Attributes inherited from FGOutputSocket
int	precision
FGfdmSocket *	socket
std::string	SockName
unsigned int	SockPort
FGfdmSocket::ProtocolType	SockProtocol
Protected Attributes inherited from FGOutputType
std::shared_ptr< FGAccelerations >	Accelerations
std::shared_ptr< FGAerodynamics >	Aerodynamics
std::shared_ptr< FGAircraft >	Aircraft
std::shared_ptr< FGAuxiliary >	Auxiliary
std::shared_ptr< FGBuoyantForces >	BuoyantForces
bool	enabled
std::shared_ptr< FGExternalReactions >	ExternalReactions
std::shared_ptr< FGFCS >	FCS
std::shared_ptr< FGGroundReactions >	GroundReactions
std::shared_ptr< FGMassBalance >	MassBalance
std::vector< std::string >	OutputCaptions
unsigned int	OutputIdx
std::vector< FGPropertyValue * >	OutputParameters
std::shared_ptr< FGPropagate >	Propagate
std::shared_ptr< FGPropulsion >	Propulsion
int	SubSystems
std::shared_ptr< FGWinds >	Winds
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
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/(fttom*fttom*fttom)
static constexpr double	in3tom3 = inchtoft*inchtoft*inchtoft/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

FGOutputFG()

FGOutputFG

(

FGFDMExec *

fdmex

)

Constructor.

Definition at line 117 of file FGOutputFG.cpp.

                                       :
  FGOutputSocket(fdmex), outputOptions{false, 1e6}
{
  memset(&fgSockBuf, 0x0, sizeof(fgSockBuf));
 
  if (fdmex->GetDebugLevel() > 0) {
    // Engine status
    if (Propulsion->GetNumEngines() > FGNetFDM::FG_MAX_ENGINES)
      cerr << "This vehicle has " << Propulsion->GetNumEngines() << " engines, but the current " << endl
           << "version of FlightGear's FGNetFDM only supports " << FGNetFDM::FG_MAX_ENGINES << " engines." << endl
           << "Only the first " << FGNetFDM::FG_MAX_ENGINES << " engines will be used." << endl;
 
    // Consumables
    if (Propulsion->GetNumTanks() > FGNetFDM::FG_MAX_TANKS)
      cerr << "This vehicle has " << Propulsion->GetNumTanks() << " tanks, but the current " << endl
           << "version of FlightGear's FGNetFDM only supports " << FGNetFDM::FG_MAX_TANKS << " tanks." << endl
           << "Only the first " << FGNetFDM::FG_MAX_TANKS << " tanks will be used." << endl;
 
    // Gear status
    if (GroundReactions->GetNumGearUnits() > FGNetFDM::FG_MAX_WHEELS)
      cerr << "This vehicle has " << GroundReactions->GetNumGearUnits() << " bogeys, but the current " << endl
           << "version of FlightGear's FGNetFDM only supports " << FGNetFDM::FG_MAX_WHEELS << " bogeys." << endl
           << "Only the first " << FGNetFDM::FG_MAX_WHEELS << " bogeys will be used." << endl;
  }
}

Here is the call graph for this function:

Member Function Documentation

Load()

bool Load ( Element *  el )

overridevirtual

Evaluate the output directives from an XML file.

Parameters

element

XML Element that is pointing to the output directives

Reimplemented from FGModel.

Definition at line 145 of file FGOutputFG.cpp.

{
  if (!FGOutputSocket::Load(el)) {
    return false;
  }
 
  // Check if there is a <time> element
  Element* time_el = el->FindElement("time");
  if (time_el) {
    // Check if the attribute "type" is specified and is set to "simulation"
    if (time_el->HasAttribute("type") && time_el->GetAttributeValue("type") == "simulation") {
      outputOptions.useSimTime = true;
    }
 
    // Check if the attribute "resolution" is specified and set to a valid value
    if (time_el->HasAttribute("resolution")) {
      if (time_el->GetAttributeValueAsNumber("resolution") <= 1 &&
          time_el->GetAttributeValueAsNumber("resolution") >= 1e-9) {
        outputOptions.timeFactor = 1./time_el->GetAttributeValueAsNumber("resolution");
      } else {
        return false;
      }
    }
  }
  return true;
}

Here is the call graph for this function:

Print()

void Print ( void  )

overridevirtual

Generate the output.

This is a pure method so it must be implemented by the classes that inherits from FGOutputType. The Print name may not be relevant to all outputs but it has been kept for backward compatibility.

Implements FGOutputType.

Definition at line 378 of file FGOutputFG.cpp.

{
  int length = sizeof(fgSockBuf);
 
  if (socket == 0) return;
  if (!socket->GetConnectStatus()) return;
 
  SocketDataFill(&fgSockBuf);
  socket->Send((char *)&fgSockBuf, length);
}

Here is the call graph for this function:

PrintHeaders()

void PrintHeaders ( void  )

inlineoverrideprotectedvirtual

Reimplemented from FGOutputSocket.

Definition at line 77 of file FGOutputFG.h.

{};

Member Data Documentation

timeFactor

double timeFactor

Definition at line 83 of file FGOutputFG.h.

useSimTime

bool useSimTime

Definition at line 82 of file FGOutputFG.h.

---

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

• FGOutputFG.h
• FGOutputFG.cpp