FGOutput Class Reference

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="localhost" type="FLIGHTGEAR" port="5500" protocol="tcp" rate="10"/>

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

Definition at line 125 of file FGOutput.h.

#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.
SGPath	FindFullPathName (const SGPath &path) const override
void	ForceOutput (int idx)
	Force an output instance to generate its output.
std::string	GetOutputName (unsigned int idx) const
	Get the name identifier to which the output will be directed.
bool	InitModel (void) override
	Initializes the instance.
bool	Load (Element *el) override
bool	Load (Element *el, const SGPath &dir)
	Load the output directives and adds a new output instance to the Output Manager list.
bool	Load (int subSystems, std::string protocol, std::string type, std::string port, std::string name, double outRate, std::vector< SGPropertyNode_ptr > &outputProperties)
	Load the output directives and adds a new output instance to the Output Manager list.
void	Print (void)
	Makes all the output instances to generate their ouput.
bool	Run (bool Holding) override
	Runs the Output model; called by the Executive.
bool	SetDirectivesFile (const SGPath &fname)
	Adds a new output instance to the Output Manager.
bool	SetOutputName (unsigned int idx, const std::string &name)
	Overwrites the name identifier under which the output will be logged.
void	SetRateHz (double rate)
	Modifies the output rate for all output instances.
void	SetStartNewOutput (void)
	Reset the output prior to a restart of the simulation.
bool	Toggle (int idx)
	Toggles the output generation of each ouput instance.
Public Member Functions inherited from FGModel
	FGModel (FGFDMExec *, const std::string &name)
	Constructor.
	~FGModel () override
	Destructor.
FGFDMExec *	GetExec (void) const
const std::string &	GetName (void) const
unsigned int	GetRate (void) const
	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.

Additional Inherited Members
Public Types inherited from FGJSBBase
enum	{ eL = 1 , eM , eN }
	Moments L, M, N. More...
enum	{ eP = 1 , eQ , eR }
	Rates P, Q, R. More...
enum	{ eU = 1 , eV , eW }
	Velocities U, V, W. More...
enum	{ eX = 1 , eY , eZ }
	Positions X, Y, Z. More...
enum	{ ePhi = 1 , eTht , ePsi }
	Euler angles Phi, Theta, Psi. More...
enum	{ eDrag = 1 , eSide , eLift }
	Stability axis forces, Drag, Side force, Lift. More...
enum	{ eRoll = 1 , ePitch , eYaw }
	Local frame orientation Roll, Pitch, Yaw. More...
enum	{ eNorth = 1 , eEast , eDown }
	Local frame position North, East, Down. More...
enum	{ eLat = 1 , eLong , eRad }
	Locations Radius, Latitude, Longitude. More...
enum	{   inNone = 0 , inDegrees , inRadians , inMeters ,   inFeet }
	Conversion specifiers. More...
Static Public Member Functions inherited from FGJSBBase
static constexpr double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit.
static constexpr double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin.
static constexpr double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine.
static constexpr double	Constrain (double min, double value, double max)
	Constrain a value between a minimum and a maximum value.
static bool	EqualToRoundoff (double a, double b)
	Finite precision comparison.
static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison.
static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison.
static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison.
static constexpr double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius.
static constexpr double	FeetToMeters (double measure)
	Converts from feet to meters.
static const std::string &	GetVersion (void)
	Returns the version number of JSBSim.
static constexpr double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius.
static constexpr double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit.
static constexpr double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine.
static constexpr double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius.
static constexpr double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin.
static constexpr double	sign (double num)
Static Public Attributes inherited from FGJSBBase
static short	debug_lvl = 1
Protected Member Functions inherited from FGModel
bool	Upload (Element *el, bool preLoad)
	Uploads this model in memory.
Static Protected Member Functions inherited from FGJSBBase
static std::string	CreateIndexedPropertyName (const std::string &Property, int index)
Protected Attributes inherited from FGModel
bool	enabled = true
unsigned int	exe_ctr
FGFDMExec *	FDMExec
std::string	Name
std::shared_ptr< FGPropertyManager >	PropertyManager
unsigned int	rate
Protected Attributes inherited from FGModelFunctions
FGPropertyReader	LocalProperties
std::vector< std::shared_ptr< FGFunction > >	PostFunctions
std::vector< std::shared_ptr< FGFunction > >	PreFunctions
Static Protected Attributes inherited from FGJSBBase
static constexpr double	degtorad = M_PI / 180.
static constexpr double	fpstokts = 1.0 / ktstofps
static constexpr double	fttom = 0.3048
static constexpr double	hptoftlbssec = 550.0
static constexpr double	in3tom3 = inchtoft*inchtoft*inchtoft/m3toft3
static constexpr double	inchtoft = 1.0/12.0
static constexpr double	inhgtopa = 3386.38
static const std::string	JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__
static constexpr double	kgtolb = 2.20462
static constexpr double	kgtoslug = 0.06852168
static constexpr double	ktstofps = 1852./(3600*fttom)
static constexpr double	lbtoslug = 1.0/slugtolb
static constexpr double	m3toft3 = 1.0/(fttom*fttom*fttom)
static const std::string	needed_cfg_version = "2.0"
static constexpr double	psftoinhg = 0.014138
static constexpr double	psftopa = 47.88
static constexpr double	radtodeg = 180. / M_PI
static constexpr double	slugtolb = 32.174049
	Note that definition of lbtoslug by the inverse of slugtolb and not to a different constant you can also get from some tables will make lbtoslug*slugtolb == 1 up to the magnitude of roundoff.

Constructor & Destructor Documentation

FGOutput()

FGOutput

(

FGFDMExec *

fdmex

)

Definition at line 58 of file FGOutput.cpp.

                                   : FGModel(fdmex, "FGOutput")
{
  enabled = true;
 
  PropertyManager->Tie<FGOutput, int>("simulation/force-output", this, nullptr,
                                      &FGOutput::ForceOutput);
 
  Debug(0);
}

~FGOutput()

~FGOutput ( )

override

Definition at line 70 of file FGOutput.cpp.

{
  for (auto output: OutputTypes)
    delete output;
 
  Debug(1);
}

Member Function Documentation

Disable()

void Disable ( void  )

inline

Disables the output generation for all output instances.

Definition at line 182 of file FGOutput.h.

{ enabled = false; }

Enable()

void Enable ( void  )

inline

Enables the output generation for all output instances.

Definition at line 180 of file FGOutput.h.

{ enabled = true; }

FindFullPathName()

SGPath FindFullPathName ( const SGPath &  path ) const

overridevirtual

Reimplemented from FGModel.

Definition at line 293 of file FGOutput.cpp.

{
  // Check optional include path if set
  if (!includePath.isNull()) {
    SGPath name = CheckPathName(includePath, path);
    if (!name.isNull()) return name;
  }
 
  return FGModel::FindFullPathName(path);
}

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

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

InitModel()

bool InitModel ( void  )

overridevirtual

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

{
  bool ret = false;
 
  if (!FGModel::InitModel()) return false;
 
  for (auto output: OutputTypes)
    ret &= output->InitModel();
 
  return ret;
}

Load() [1/3]

bool Load ( Element *  el )

inlineoverridevirtual

Reimplemented from FGModel.

Definition at line 199 of file FGOutput.h.

{ return Load(el, SGPath()); }

Load() [2/3]

bool Load	(	Element *	el,
		const SGPath &	dir
	)

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
dir	optional directory path to load included files from

Returns

true if the execution succeeded.

Definition at line 243 of file FGOutput.cpp.

{
  // Optional path to use for included files
  includePath = dir;
 
  // Perform base class Pre-Load
  if (!FGModel::Upload(document, false))
    return false;
 
  size_t idx = OutputTypes.size();
  string type = document->GetAttributeValue("type");
  FGOutputType* Output = 0;
 
  if (debug_lvl > 0) {
    FGLogging log(LogLevel::DEBUG);
    log << "\n  Output data set: " << idx << "  \n";
  }
 
  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 == "TERMINAL") {
    // Not done yet
  } else if (type != string("NONE")) {
    FGLogging log(LogLevel::ERROR);
    log << "Unknown type of output specified in config file\n";
  }
 
  if (!Output) return false;
 
  Output->SetIdx(idx);
  Output->PreLoad(document, FDMExec);
  Output->Load(document);
  Output->PostLoad(document, FDMExec);
 
  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() [3/3]

bool Load	(	int	subSystems,
		std::string	protocol,
		std::string	type,
		std::string	port,
		std::string	name,
		double	outRate,
		std::vector< SGPropertyNode_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 192 of file FGOutput.cpp.

{
  size_t idx = OutputTypes.size();
  FGOutputType* Output = 0;
 
  if (debug_lvl > 0) {
    FGLogging log(LogLevel::DEBUG);
    log << "\n  Output data set: " << idx << "\n";
  }
 
  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 == "TERMINAL") {
    // Not done yet
  } else if (type != string("NONE")) {
    FGLogging log(LogLevel::ERROR);
    log << "Unknown type of output specified in config file\n";
  }
 
  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 108 of file FGOutput.cpp.

{
  for (auto output: OutputTypes)
    output->Print();
}

Run()

bool Run ( bool  Holding )

overridevirtual

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

{
  if (FDMExec->GetTrimStatus()) return true;
  if (FGModel::Run(Holding)) return true;
  if (Holding) return false;
 
  for (auto output: OutputTypes)
    output->Run(Holding);
 
  return false;
}

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

{
  FGXMLFileRead XMLFile;
  Element* document = XMLFile.LoadXMLDocument(fname);
  if (!document) {
    LogException err;
    err << "Could not read directive file: " << fname;
    throw err;
  }
 
  bool result = Load(document);
  if (!result) {
    FGLogging log(LogLevel::ERROR);
    log << "\nAircraft output element has problems in file " << fname << "\n";
  }
 
  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 150 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 134 of file FGOutput.cpp.

{
  for (auto output: OutputTypes)
    output->SetRateHz(rate);
}

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

{
  for (auto output: OutputTypes)
    output->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 124 of file FGOutput.cpp.

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

---

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

• FGOutput.h
• FGOutput.cpp