FGOutputType Class Reference

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

#include <FGOutputType.h>

Inheritance diagram for FGOutputType:

Collaboration diagram for FGOutputType:

Public Types
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.
enum	{ eP = 1, eQ, eR }
	Rates P, Q, R.
enum	{ eU = 1, eV, eW }
	Velocities U, V, W.
enum	{ eX = 1, eY, eZ }
	Positions X, Y, Z.
enum	{ ePhi = 1, eTht, ePsi }
	Euler angles Phi, Theta, Psi.
enum	{ eDrag = 1, eSide, eLift }
	Stability axis forces, Drag, Side force, Lift.
enum	{ eRoll = 1, ePitch, eYaw }
	Local frame orientation Roll, Pitch, Yaw.
enum	{ eNorth = 1, eEast, eDown }
	Local frame position North, East, Down.
enum	{ eLat = 1, eLong, eRad }
	Locations Radius, Latitude, Longitude.
enum	{   inNone = 0, inDegrees, inRadians, inMeters,   inFeet }
	Conversion specifiers.

Public Member Functions
	FGOutputType (FGFDMExec *fdmex)
	Constructor (implement the FGModel interface). More...
virtual	~FGOutputType ()
	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. More...
double	GetRateHz (void) const
	Get the output rate in Hz for this output.
virtual bool	InitModel (void)
	Init the output model according to its configitation.
virtual bool	Load (Element *el)
	Init the output directives from an XML file (implement the FGModel interface). More...
virtual void	Print (void)=0
	Generate the output. More...
bool	Run (void)
	Executes the output directives (implement the FGModel interface). More...
void	SetIdx (unsigned int idx)
	Set the idx for this output instance. More...
virtual void	SetOutputName (const std::string &name)
	Overwrites the name identifier under which the output will be logged. More...
void	SetOutputProperties (std::vector< FGPropertyNode_ptr > &outputProperties)
	Set the list of properties that should be output for this output instance. More...
void	SetRateHz (double rtHz)
	Set the output rate for this output instances. More...
virtual void	SetStartNewOutput (void)
	Reset the output prior to a restart of the simulation. More...
void	SetSubSystems (int subSystems)
	Set the activated subsystems for this output instance. More...
bool	Toggle (void)
	Toggles the output generation. More...
Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *)
	Constructor.
virtual	~FGModel ()
	Destructor.
virtual SGPath	FindFullPathName (const SGPath &path) const
FGFDMExec *	GetExec (void)
unsigned int	GetRate (void)
	Get the output rate for the model in frames.
virtual bool	Run (bool Holding)
	Runs the model; called by the Executive. More...
void	SetPropertyManager (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. More...
std::string	GetFunctionValues (const std::string &delimeter) const
	Gets the function values. More...
FGFunction *	GetPreFunction (const std::string &name)
	Get one of the "pre" function. More...
bool	Load (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
void	PostLoad (Element *el, FGPropertyManager *PropertyManager, std::string prefix="")
void	PreLoad (Element *el, FGPropertyManager *PropertyManager, 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.
std::string	GetVersion (void)
	Returns the version number of JSBSim. More...
void	PutMessage (const Message &msg)
	Places a Message structure on the Message queue. More...
void	PutMessage (const std::string &text)
	Creates a message with the given text and places it on the queue. More...
void	PutMessage (const std::string &text, bool bVal)
	Creates a message with the given text and boolean value and places it on the queue. More...
void	PutMessage (const std::string &text, int iVal)
	Creates a message with the given text and integer value and places it on the queue. More...
void	PutMessage (const std::string &text, double dVal)
	Creates a message with the given text and double value and places it on the queue. More...
int	SomeMessages (void)
	Reads the message on the queue (but does not delete it). More...
void	ProcessMessage (void)
	Reads the message on the queue and removes it from the queue. More...
Message *	ProcessNextMessage (void)
	Reads the next message on the queue and removes it from the queue. More...

Public Attributes
enum JSBSim::FGOutputType::eSubSystems	subsystems
Public Attributes inherited from FGModel
std::string	Name

Protected Member Functions
void	Debug (int from)
Protected Member Functions inherited from FGJSBBase
void	Debug (int)

Protected Attributes
FGAccelerations *	Accelerations
FGAerodynamics *	Aerodynamics
FGAircraft *	Aircraft
FGAtmosphere *	Atmosphere
FGAuxiliary *	Auxiliary
FGBuoyantForces *	BuoyantForces
bool	enabled
FGExternalReactions *	ExternalReactions
FGFCS *	FCS
FGGroundReactions *	GroundReactions
FGMassBalance *	MassBalance
std::vector< std::string >	OutputCaptions
unsigned int	OutputIdx
std::vector< FGPropertyNode_ptr >	OutputProperties
FGPropagate *	Propagate
FGPropulsion *	Propulsion
int	SubSystems
FGWinds *	Winds
Protected Attributes inherited from FGModel
unsigned int	exe_ctr
FGFDMExec *	FDMExec
FGPropertyManager *	PropertyManager
unsigned int	rate
Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties
std::vector< FGFunction * >	PostFunctions
std::vector< FGFunction * >	PreFunctions

Additional Inherited Members
Static Public Member Functions inherited from FGJSBBase
static double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit. More...
static double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin. More...
static double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine. More...
static 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. More...
static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison. More...
static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison. More...
static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison. More...
static double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius. More...
static double	FeetToMeters (double measure)
	Converts from feet to meters. More...
static double	GaussianRandomNumber (void)
static double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius. More...
static double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit. More...
static double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine. More...
static double	MachFromVcalibrated (double vcas, double p, double psl, double rhosl)
	Calculate the Mach number from the calibrated airspeed. More...
static double	PitotTotalPressure (double mach, double p)
	Compute the total pressure in front of the Pitot tube. More...
static double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius. More...
static double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin. More...
static double	sign (double num)
static double	VcalibratedFromMach (double mach, double p, double psl, double rhosl)
	Calculate the calibrated airspeed from the Mach number. More...
Static Public Attributes inherited from FGJSBBase
static short	debug_lvl = 1
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 Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)
Static Protected Attributes inherited from FGJSBBase
static const double	degtorad = 0.017453292519943295769236907684886
static const double	fpstokts = 1.0/ktstofps
static const double	fttom = 0.3048
static int	gaussian_random_number_phase = 0
static const double	hptoftlbssec = 550.0
static const double	in3tom3 = 1.638706E-5
static const double	inchtoft = 0.08333333
static const double	inhgtopa = 3386.38
static const std::string	JSBSim_version = "1.0 " __DATE__ " " __TIME__
static const double	kgtolb = 2.20462
static const double	kgtoslug = 0.06852168
static const double	ktstofps = 1.68781
static const double	lbtoslug = 1.0/slugtolb
static Message	localMsg
static const double	m3toft3 = 1.0/(fttom*fttom*fttom)
static double	Mair = 28.9645
static unsigned int	messageId = 0
static std::queue< Message >	Messages
static const std::string	needed_cfg_version = "2.0"
static const double	psftoinhg = 0.014138
static const double	psftopa = 47.88
static const double	radtodeg = 57.295779513082320876798154814105
static double	Reng = 1716.56
static double	Rstar = 1545.348
static const double	SHRatio = 1.40
static const double	slugtolb = 32.174049

Detailed Description

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

This class is used by the output manager FGOutput to manage a list of different output classes without needing to know the details of each one of them. It also provides the functions that are common to all the output classes.

The class inherits from FGModelFunctions so it is possible to define functions that execute before or after the output 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 95 of file FGOutputType.h.

Member Enumeration Documentation

eSubSystems

enum eSubSystems

Subsystem types for specifying which will be output in the FDM data logging.

Enumerator
ssSimulation	Subsystem: Simulation (= 1)
ssAerosurfaces	Subsystem: Aerosurfaces (= 2)
ssRates	Subsystem: Body rates (= 4)
ssVelocities	Subsystem: Velocities (= 8)
ssForces	Subsystem: Forces (= 16)
ssMoments	Subsystem: Moments (= 32)
ssAtmosphere	Subsystem: Atmosphere (= 64)
ssMassProps	Subsystem: Mass Properties (= 128)
ssAeroFunctions	Subsystem: Coefficients (= 256)
ssPropagate	Subsystem: Propagate (= 512)
ssGroundReactions	Subsystem: Ground Reactions (= 1024)
ssFCS	Subsystem: FCS (= 2048)
ssPropulsion	Subsystem: Propulsion (= 4096)

Definition at line 183 of file FGOutputType.h.

                    { 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
  } subsystems;

Constructor & Destructor Documentation

FGOutputType()

FGOutputType

(

FGFDMExec *

fdmex

)

Constructor (implement the FGModel interface).

Parameters

fdmex

a pointer to the parent executive object

Definition at line 58 of file FGOutputType.cpp.

                                           :
  FGModel(fdmex),
  SubSystems(0),
  enabled(true)
{
  Aerodynamics = FDMExec->GetAerodynamics();
  Auxiliary = FDMExec->GetAuxiliary();
  Aircraft = FDMExec->GetAircraft();
  Atmosphere = FDMExec->GetAtmosphere();
  Winds = FDMExec->GetWinds();
  Propulsion = FDMExec->GetPropulsion();
  MassBalance = FDMExec->GetMassBalance();
  Propagate = FDMExec->GetPropagate();
  Accelerations = FDMExec->GetAccelerations();
  FCS = FDMExec->GetFCS();
  GroundReactions = FDMExec->GetGroundReactions();
  ExternalReactions = FDMExec->GetExternalReactions();
  BuoyantForces = FDMExec->GetBuoyantForces();

  Debug(0);
}

Here is the call graph for this function:

Member Function Documentation

GetOutputName()

virtual const std::string& GetOutputName ( void  ) const

inlinevirtual

Get the name identifier to which the output will be directed.

Returns

the name identifier.

Definition at line 141 of file FGOutputType.h.

{ return Name; }

Here is the call graph for this function:

Load()

bool Load ( Element *  el )

virtual

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

Parameters

element

XML Element that is pointing to the output directives

Reimplemented from FGModel.

Reimplemented in FGOutputSocket, FGOutputFile, FGOutputTextFile, and FGUDPOutputSocket.

Definition at line 101 of file FGOutputType.cpp.

{
  if (element->FindElementValue("simulation") == string("ON"))
    SubSystems += ssSimulation;
  if (element->FindElementValue("aerosurfaces") == string("ON"))
    SubSystems += ssAerosurfaces;
  if (element->FindElementValue("rates") == string("ON"))
    SubSystems += ssRates;
  if (element->FindElementValue("velocities") == string("ON"))
    SubSystems += ssVelocities;
  if (element->FindElementValue("forces") == string("ON"))
    SubSystems += ssForces;
  if (element->FindElementValue("moments") == string("ON"))
    SubSystems += ssMoments;
  if (element->FindElementValue("atmosphere") == string("ON"))
    SubSystems += ssAtmosphere;
  if (element->FindElementValue("massprops") == string("ON"))
    SubSystems += ssMassProps;
  if (element->FindElementValue("position") == string("ON"))
    SubSystems += ssPropagate;
  if (element->FindElementValue("coefficients") == string("ON") || element->FindElementValue("aerodynamics") == string("ON"))
    SubSystems += ssAeroFunctions;
  if (element->FindElementValue("ground_reactions") == string("ON"))
    SubSystems += ssGroundReactions;
  if (element->FindElementValue("fcs") == string("ON"))
    SubSystems += ssFCS;
  if (element->FindElementValue("propulsion") == string("ON"))
    SubSystems += ssPropulsion;

  Element *property_element = element->FindElement("property");

  while (property_element) {
    string property_str = property_element->GetDataLine();
    FGPropertyNode* node = PropertyManager->GetNode(property_str);
    if (!node) {
      cerr << fgred << highint << endl << "  No property by the name "
           << property_str << " has been defined. This property will " << endl
           << "  not be logged. You should check your configuration file."
           << reset << endl;
    } else {
      OutputProperties.push_back(node);
      if (property_element->HasAttribute("caption")) {
        OutputCaptions.push_back(property_element->GetAttributeValue("caption"));
      } else {
        OutputCaptions.push_back("");
      }
    }
    property_element = element->FindNextElement("property");
  }

  double outRate = 1.0;
  if (!element->GetAttributeValue("rate").empty()) {
    outRate = element->GetAttributeValueAsNumber("rate");
  }
  SetRateHz(outRate);

  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Print()

virtual void Print ( void  )

pure virtual

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.

Implemented in FGOutputFile, FGOutputSocket, FGUDPOutputSocket, FGOutputTextFile, and FGOutputFG.

Here is the caller graph for this function:

Run()

bool Run

(

void

)

Executes the output directives (implement the FGModel interface).

This method checks that the current time step matches the output rate and calls the registered "pre" functions, the output generation and finally the "post" functions.

Returns

false if no error.

Definition at line 172 of file FGOutputType.cpp.

{
  if (FGModel::Run(false)) return true;
  if (!enabled) return true;

  RunPreFunctions();
  Print();
  RunPostFunctions();

  Debug(4);

  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetIdx()

void SetIdx

(

unsigned int

idx

)

Set the idx for this output instance.

Parameters

idx	ID of the output instance that is constructed

Definition at line 90 of file FGOutputType.cpp.

{
  string outputProp = CreateIndexedPropertyName("simulation/output", idx);

  PropertyManager->Tie(outputProp + "/log_rate_hz", this, &FGOutputType::GetRateHz, &FGOutputType::SetRateHz, false);
  PropertyManager->Tie(outputProp + "/enabled", &enabled);
  OutputIdx = idx;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetOutputName()

virtual void SetOutputName ( const std::string &  name )

inlinevirtual

Overwrites the name identifier under which the output will be logged.

This method is taken into account if it is called before FGFDMExec::RunIC() otherwise it is ignored until the next call to SetStartNewOutput().

Parameters

name

new name

Reimplemented in FGOutputFile, and FGOutputSocket.

Definition at line 137 of file FGOutputType.h.

{ Name = name; }

Here is the caller graph for this function:

SetOutputProperties()

void SetOutputProperties ( std::vector< FGPropertyNode_ptr > &  outputProperties )

inline

Set the list of properties that should be output for this output instance.

Parameters

outputProperties

list of properties that should be output

Definition at line 127 of file FGOutputType.h.

  {
    OutputProperties = outputProperties;
  }

Here is the caller graph for this function:

SetRateHz()

void SetRateHz

(

double

rtHz

)

Set the output rate for this output instances.

Parameters

rtHz	new output rate in Hz

Definition at line 188 of file FGOutputType.cpp.

{
  rtHz = rtHz>1000?1000:(rtHz<0?0:rtHz);
  if (rtHz > 0) {
    SetRate(0.5 + 1.0/(FDMExec->GetDeltaT()*rtHz));
    Enable();
  } else {
    SetRate(1);
    Disable();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetStartNewOutput()

virtual void SetStartNewOutput ( void  )

inlinevirtual

Reset the output prior to a restart of the simulation.

This method should be called when the simulation is restarted with, for example, new initial conditions. When this method is executed the output instance can take special actions such as closing the current output file and open a new one with a different name.

Reimplemented in FGOutputFile.

Definition at line 171 of file FGOutputType.h.

{}

SetSubSystems()

void SetSubSystems ( int  subSystems )

inline

Set the activated subsystems for this output instance.

Parameters

subSystems	bitfield that describes the activated subsystems
outputProperties	list of properties that should be output

Definition at line 122 of file FGOutputType.h.

{ SubSystems = subSystems; }

Here is the caller graph for this function:

Toggle()

bool Toggle ( void  )

inline

Toggles the output generation.

Returns

the output generation status i.e. true if the output has been enabled, false if the output has been disabled.

Definition at line 180 of file FGOutputType.h.

{enabled = !enabled; return enabled;}

---

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

• FGOutputType.h
• FGOutputType.cpp