Detailed Description

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

A new class derived from FGOutputFile should be created for each file format that JSBSim is able to output.

This class provides all the machinery necessary to manage the file naming including the sequence in which the file should be opened then closed. The logic of SetStartNewOutput() is also managed in this class. Derived class should normally not need to reimplement this method. In most cases, derived classes only need to implement the methods OpenFile(), CloseFile() and Print().

Definition at line 70 of file FGOutputFile.h.

#include <FGOutputFile.h>

Inheritance diagram for FGOutputFile:

Collaboration diagram for FGOutputFile:

Public Member Functions
	FGOutputFile (FGFDMExec *fdmex)
	Constructor.

	~FGOutputFile () override
	Destructor : closes the file.

bool	InitModel (void) override
	Initializes the instance.

bool	Load (Element *el) override
	Init the output directives from an XML file.

void	Print (void) override=0
	Generate the output.

void	SetOutputName (const std::string &fname) override
	Overwrites the name identifier under which the output will be logged.

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

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.

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
virtual void	CloseFile (void)
	Closes the file.

virtual bool	OpenFile (void)=0
	Opens the file.

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.

Protected Attributes
SGPath	Filename

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

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)

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

static constexpr double	in3tom3 = inchtoftinchtoftinchtoft/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

◆ FGOutputFile()

FGOutputFile ( FGFDMExec * fdmex )

Constructor.

Definition at line 54 of file FGOutputFile.cpp.

                                           :
  FGOutputType(fdmex),
  runID_postfix(-1)
{
}

◆ ~FGOutputFile()

~FGOutputFile ( )

inlineoverride

Destructor : closes the file.

Definition at line 77 of file FGOutputFile.h.

77{ CloseFile(); }

JSBSim::FGOutputFile::CloseFile

virtual void CloseFile(void)

Closes the file.

Definition FGOutputFile.h:118

Here is the call graph for this function:

Member Function Documentation

◆ CloseFile()

virtual void CloseFile ( void )

inlineprotectedvirtual

Closes the file.

Reimplemented in FGOutputTextFile.

Definition at line 118 of file FGOutputFile.h.

118{}

Here is the caller graph for this function:

◆ InitModel()

bool InitModel ( void )

overridevirtual

Initializes the instance.

This method basically opens the file to which outputs will be directed.

Returns: true if the execution succeeded.

Reimplemented from FGModel.

Definition at line 62 of file FGOutputFile.cpp.

{
  if (FGOutputType::InitModel()) {
    if (Filename.isNull()) {
      Filename = SGPath(Name);
      runID_postfix = 0;
    }
    return OpenFile();
  }
 
  return false;
}

Here is the call graph for this function:

◆ Load()

bool Load ( Element * el )

overridevirtual

Init the output directives from an XML file.

Parameters

element XML Element that is pointing to the output directives

Reimplemented from FGModel.

Reimplemented in FGOutputTextFile.

Definition at line 95 of file FGOutputFile.cpp.

{
  if (!FGOutputType::Load(el))
    return false;
  
  SetOutputName(el->GetAttributeValue("name"));
  
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OpenFile()

virtual bool OpenFile ( void )

protectedpure virtual

Opens the file.

Implemented in FGOutputTextFile.

Here is the caller graph for this function:

◆ Print()

void Print ( void )

overridepure virtual

Generate the output.

This is a pure method so it must be implemented by the classes that inherits from FGOutputFile.

Implements FGOutputType.

Implemented in FGOutputTextFile.

◆ SetOutputName()

void SetOutputName ( const std::string & fname )

inlineoverridevirtual

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

For this method to take effect, it must be called prior to FGFDMExec::RunIC(). If it is called after, it will not take effect before the next call to SetStartNewOutput().

Parameters

name new name

Reimplemented from FGOutputType.

Definition at line 102 of file FGOutputFile.h.

                                                      {
    Name = (FDMExec->GetOutputPath()/fname).utf8Str();
    runID_postfix = -1;
    Filename = SGPath();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetStartNewOutput()

void SetStartNewOutput ( void )

overridevirtual

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. The current file is closed and reopened with a new name. The new name is contructed from the base file name set by the class constructor or SetOutputName() and is appended with an underscore _ and an ID that is incremented at each call to this method.

Reimplemented from FGOutputType.

Definition at line 77 of file FGOutputFile.cpp.

{
  if (runID_postfix >= 0) {
    ostringstream buf;
    string::size_type dot = Name.find_last_of('.');
    if (dot != string::npos) {
      buf << Name.substr(0, dot) << '_' << runID_postfix++ << Name.substr(dot);
    } else {
      buf << Name << '_' << runID_postfix++;
    }
    Filename = SGPath(buf.str());
  }
 
  CloseFile();
}

Here is the call graph for this function:

Member Data Documentation

◆ Filename

SGPath Filename

protected

Definition at line 113 of file FGOutputFile.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FGOutputFile()

◆ ~FGOutputFile()

Member Function Documentation

◆ CloseFile()

◆ InitModel()

◆ Load()

◆ OpenFile()

◆ Print()

◆ SetOutputName()

◆ SetStartNewOutput()

Member Data Documentation

◆ Filename