Handles simulation output. More...

#include <FGOutput.h>

Inheritance diagram for FGOutput:

Collaboration diagram for FGOutput:

Public Member Functions
	FGOutput (FGFDMExec *)

void	Disable (void)
	Disables the output generation for all output instances.

void	Enable (void)
	Enables the output generation for all output instances.

void	ForceOutput (int idx)
	Force an output instance to generate its output. More...

std::string	GetOutputName (unsigned int idx) const
	Get the name identifier to which the output will be directed. More...

bool	InitModel (void)
	Initializes the instance. More...

bool	Load (Element *el)
	Load the output directives and adds a new output instance to the Output Manager list. More...

bool	Load (int subSystems, std::string protocol, std::string type, std::string port, std::string name, double outRate, std::vector< FGPropertyNode_ptr > &outputProperties)
	Load the output directives and adds a new output instance to the Output Manager list. More...

void	Print (void)
	Makes all the output instances to generate their ouput. More...

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

bool	SetDirectivesFile (const SGPath &fname)
	Adds a new output instance to the Output Manager. More...

bool	SetOutputName (unsigned int idx, const std::string &name)
	Overwrites the name identifier under which the output will be logged. More...

void	SetRateHz (double rate)
	Modifies the output rate for all output instances. More...

void	SetStartNewOutput (void)
	Reset the output prior to a restart of the simulation. More...

bool	Toggle (int idx)
	Toggles the output generation of each ouput instance. 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.

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

Additional Inherited Members
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.

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

Public Attributes inherited from FGModel
std::string	Name

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

Protected Member Functions inherited from FGJSBBase
void	Debug (int)

Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)

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

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

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

Handles simulation output.

OUTPUT section definition

The following specifies the way that JSBSim writes out data.

    NAME is the filename you want the output to go to

    TYPE can be:
      CSV         Comma separated data. If a filename is supplied then the
                  data goes to that file. If "COUT" or "cout" is specified, the
                  data goes to stdout. If the filename is a null filename the
                  data goes to stdout, as well.
      SOCKET      Will eventually send data to a socket output, where NAME
                  would then be the IP address of the machine the data should
                  be sent to. DON'T USE THIS YET!
      FLIGHTGEAR  A socket is created for sending binary data packets to
                  an external instance of FlightGear for visuals.  Parameters
                  defining the socket are given on the <output> line.
      TABULAR     Columnar data.
      TERMINAL    Output to terminal. NOT IMPLEMENTED YET!
      NONE        Specifies to do nothing. This setting makes it easy to turn on and
                  off the data output without having to mess with anything else.

      Examples:

<output name="B737_datalog.csv" type="CSV" rate="20">
   <property> velocities/vc-kts </property>
   <velocities> ON </velocities>
</output>

    The arguments that can be supplied, currently, are:

    RATE_IN_HZ  An integer rate in times-per-second that the data is output. This
                value may not be *exactly* what you want, due to the dependence
                on dt, the cycle rate for the FDM.

    The following parameters tell which subsystems of data to output:

    simulation       ON|OFF
    atmosphere       ON|OFF
    massprops        ON|OFF
    aerosurfaces     ON|OFF
    rates            ON|OFF
    velocities       ON|OFF
    forces           ON|OFF
    moments          ON|OFF
    position         ON|OFF
    coefficients     ON|OFF
    ground_reactions ON|OFF
    fcs              ON|OFF
    propulsion       ON|OFF

NOTE that Time is always output with the data.

The class FGOutput is the manager of the outputs requested by the user. It manages a list of instances derived from the abstract class FGOutputType.

Version

Id: FGOutput.h,v 1.34 2017/02/25 14:23:19 bcoconni Exp

Definition at line 131 of file FGOutput.h.

Member Function Documentation

◆ ForceOutput()

void ForceOutput ( int idx )

Force an output instance to generate its output.

The code executed is basically the same than the code of the method Print() except that the ouput is limited to the instance identified by the parameter of the method.

Parameters

idx	ID of the instance that will generate its ouput

Definition at line 156 of file FGOutput.cpp.

 {
   if (idx >= (int)0 && idx < (int)OutputTypes.size())
     OutputTypes[idx]->Print();
 }

◆ GetOutputName()

string GetOutputName ( unsigned int idx ) const

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

Parameters

idx	ID of the output instance from which the name identifier must be obtained

Returns: the name identifier.

Definition at line 174 of file FGOutput.cpp.

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

Here is the caller graph for this function:

◆ InitModel()

bool InitModel ( void )

virtual

Initializes the instance.

This method is called by FGFDMExec::RunIC(). This is were the initialization of all classes derived from FGOutputType 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 FGModel.

Definition at line 88 of file FGOutput.cpp.

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

◆ Load() [1/2]

bool Load ( Element * el )

virtual

Load the output directives and adds a new output instance to the Output Manager list.

Parameters

el	XMLElement that is pointing to the output directives

Returns: true if the execution succeeded.

Reimplemented from FGModel.

Definition at line 249 of file FGOutput.cpp.

 {
   // Unlike the other FGModel classes, properties listed in the <output> section
   // are not intended to create new properties. For that reason, FGOutput
   // 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, PropertyManager);
 
   size_t idx = OutputTypes.size();
   string type = element->GetAttributeValue("type");
   FGOutputType* Output = 0;
 
   if (debug_lvl > 0) cout << endl << "  Output data set: " << idx << "  " << endl;
 
   type = to_upper(type);
 
   if (type == "CSV") {
     Output = new FGOutputTextFile(FDMExec);
   } else if (type == "TABULAR") {
     Output = new FGOutputTextFile(FDMExec);
   } else if (type == "SOCKET") {
     Output = new FGOutputSocket(FDMExec);
   } else if (type == "FLIGHTGEAR") {
     Output = new FGOutputFG(FDMExec);
   } else if (type == "QTJSBSIM") {
     Output = new FGUDPOutputSocket(FDMExec);
   } else if (type == "TERMINAL") {
     // Not done yet
   } else if (type != string("NONE")) {
     cerr << "Unknown type of output specified in config file" << endl;
   }
 
   if (!Output) return false;
 
   Output->SetIdx(idx);
   Output->Load(element);
   PostLoad(element, PropertyManager);
 
   OutputTypes.push_back(Output);
 
   Debug(2);
   return true;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Load() [2/2]

bool Load	(	int	subSystems,
		std::string	protocol,
		std::string	type,
		std::string	port,
		std::string	name,
		double	outRate,
		std::vector< FGPropertyNode_ptr > &	outputProperties
	)

Load the output directives and adds a new output instance to the Output Manager list.

Unlike the Load() method, the new output instance is not generated from output directives read in a XML file but from a list of parameters.

Parameters

subSystems	bitfield that describes the activated subsystems
protocol	network protocol for outputs directed to sockets
type	type of output
port	port to which the socket will be directed
name	file name to which the output will be directed
outRate	output rate in Hz
outputProperties	list of properties that should be output

Returns: true if the execution succeeded.

Definition at line 199 of file FGOutput.cpp.

 {
   size_t idx = OutputTypes.size();
   FGOutputType* Output = 0;
 
   if (debug_lvl > 0) cout << endl << "  Output data set: " << idx << endl;
 
   type = to_upper(type);
 
   if (type == "CSV") {
     FGOutputTextFile* OutputTextFile = new FGOutputTextFile(FDMExec);
     OutputTextFile->SetDelimiter(",");
     Output = OutputTextFile;
   } else if (type == "TABULAR") {
     FGOutputTextFile* OutputTextFile = new FGOutputTextFile(FDMExec);
     OutputTextFile->SetDelimiter("\t");
     Output = OutputTextFile;
   } else if (type == "SOCKET") {
     Output = new FGOutputSocket(FDMExec);
     name += ":" + port + "/" + protocol;
   } else if (type == "FLIGHTGEAR") {
     Output = new FGOutputFG(FDMExec);
     name += ":" + port + "/" + protocol;
   } else if (type == "QTJSBSIM") {
     Output = new FGUDPOutputSocket(FDMExec);
     name += ":" + port + "/" + protocol;
   } else if (type == "TERMINAL") {
     // Not done yet
   } else if (type != string("NONE")) {
     cerr << "Unknown type of output specified in config file" << endl;
   }
 
   if (!Output) return false;
 
   Output->SetIdx(idx);
   Output->SetOutputName(name);
   Output->SetRateHz(outRate);
   Output->SetSubSystems(subSystems);
   Output->SetOutputProperties(outputProperties);
 
   OutputTypes.push_back(Output);
 
   Debug(2);
   return true;
 }

Here is the call graph for this function:

◆ Print()

void Print ( void )

Makes all the output instances to generate their ouput.

This method does not check that the time step at which the output is requested is consistent with the output rate RATE_IN_HZ. Although Print is not a relevant name for outputs like SOCKET or FLIGHGEAR, it has been kept for backward compatibility.

Definition at line 119 of file FGOutput.cpp.

 {
   vector<FGOutputType*>::iterator it;
   for (it = OutputTypes.begin(); it != OutputTypes.end(); ++it)
     (*it)->Print();
 }

◆ Run()

bool Run ( bool Holding )

virtual

Runs the Output 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 103 of file FGOutput.cpp.

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

Here is the call graph for this function:

◆ SetDirectivesFile()

bool SetDirectivesFile ( const SGPath & fname )

Adds a new output instance to the Output Manager.

The definition of the new output 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 185 of file FGOutput.cpp.

 {
   FGXMLFileRead XMLFile;
   Element* document = XMLFile.LoadXMLDocument(fname);
   bool result = Load(document);
 
   if (!result)
     cerr << endl << "Aircraft output element has problems in file " << fname << endl;
 
   return result;
 }

◆ SetOutputName()

bool SetOutputName	(	unsigned int	idx,
		const std::string &	name
	)

Overwrites the name identifier under which the output 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 SetStartNewOutput().

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 164 of file FGOutput.cpp.

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

◆ SetRateHz()

void SetRateHz ( double rate )

Modifies the output rate for all output instances.

Parameters

rate	new output rate in Hz

Definition at line 147 of file FGOutput.cpp.

 {
   vector<FGOutputType*>::iterator it;
   for (it = OutputTypes.begin(); it != OutputTypes.end(); ++it)
     (*it)->SetRateHz(rate);
 }

Here is the caller graph for this function:

◆ SetStartNewOutput()

void SetStartNewOutput ( void )

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 instances can take special actions such as closing the current output file and open a new one with a different name.

Definition at line 128 of file FGOutput.cpp.

 {
   vector<FGOutputType*>::iterator it;
   for (it = OutputTypes.begin(); it != OutputTypes.end(); ++it)
     (*it)->SetStartNewOutput();
 }

Here is the caller graph for this function:

◆ Toggle()

bool Toggle ( int idx )

Toggles the output generation of each ouput instance.

Parameters

idx	ID of the output instance which output generation will be toggled.

Returns: false if the instance does not exist otherwise returns the status of the output generation (i.e. true if the output has been enabled, false if the output has been disabled)

Definition at line 137 of file FGOutput.cpp.

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

Here is the caller graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ForceOutput()

◆ GetOutputName()

◆ InitModel()

◆ Load() [1/2]

◆ Load() [2/2]

◆ Print()

◆ Run()

◆ SetDirectivesFile()

◆ SetOutputName()

◆ SetRateHz()

◆ SetStartNewOutput()

◆ Toggle()