![]() |
JSBSim Flight Dynamics Model 1.2.2 (22 Mar 2025)
An Open Source Flight Dynamics and Control Software Library in C++
|
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 91 of file FGOutputType.h.
#include <FGOutputType.h>
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... | |
![]() | |
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... | |
Public Member Functions | |
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). | |
virtual void | Print (void)=0 |
Generate the output. | |
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. | |
virtual void | SetOutputName (const std::string &name) |
Overwrites the name identifier under which the output will be logged. | |
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. | |
![]() | |
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. | |
![]() | |
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) |
![]() | |
FGJSBBase () | |
Constructor for FGJSBBase. | |
virtual | ~FGJSBBase () |
Destructor for FGJSBBase. | |
void | disableHighLighting (void) |
Disables highlighting in the console output. | |
Public Attributes | |
enum JSBSim::FGOutputType::eSubSystems | subsystems |
Protected Member Functions | |
void | Debug (int from) override |
![]() | |
bool | Upload (Element *el, bool preLoad) |
Uploads this model in memory. | |
Protected Attributes | |
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 |
![]() | |
unsigned int | exe_ctr |
FGFDMExec * | FDMExec |
std::string | Name |
std::shared_ptr< FGPropertyManager > | PropertyManager |
unsigned int | rate |
![]() | |
FGPropertyReader | LocalProperties |
std::vector< std::shared_ptr< FGFunction > > | PostFunctions |
std::vector< std::shared_ptr< FGFunction > > | PreFunctions |
Additional Inherited Members | |
![]() | |
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) |
![]() | |
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 std::string | CreateIndexedPropertyName (const std::string &Property, int index) |
![]() | |
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__ |
enum eSubSystems |
Subsystem types for specifying which will be output in the FDM data logging.
Definition at line 178 of file FGOutputType.h.
FGOutputType | ( | FGFDMExec * | fdmex | ) |
Constructor (implement the FGModel interface).
fdmex | a pointer to the parent executive object |
Definition at line 57 of file FGOutputType.cpp.
|
override |
Destructor.
Definition at line 80 of file FGOutputType.cpp.
|
overrideprotectedvirtual |
Reimplemented from FGModel.
Definition at line 250 of file FGOutputType.cpp.
|
inline |
Disables the output generation.
Definition at line 171 of file FGOutputType.h.
|
inline |
Enables the output generation.
Definition at line 169 of file FGOutputType.h.
|
inlinevirtual |
Get the name identifier to which the output will be directed.
Definition at line 134 of file FGOutputType.h.
double GetRateHz | ( | void | ) | const |
Get the output rate in Hz for this output.
Definition at line 217 of file FGOutputType.cpp.
|
overridevirtual |
Init the output model according to its configitation.
Reimplemented from FGModel.
Definition at line 177 of file FGOutputType.cpp.
|
overridevirtual |
Init the output directives from an XML file (implement the FGModel interface).
element | XML Element that is pointing to the output directives |
Reimplemented from FGModel.
Definition at line 101 of file FGOutputType.cpp.
|
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 FGOutputFG, FGOutputSocket, FGOutputTextFile, and FGOutputFile.
|
overridevirtual |
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.
Holding | if true, the executive has been directed to hold the sim from advancing time. |
Reimplemented from FGModel.
Definition at line 187 of file FGOutputType.cpp.
void SetIdx | ( | unsigned int | idx | ) |
Set the idx for this output instance.
idx | ID of the output instance that is constructed |
Definition at line 90 of file FGOutputType.cpp.
|
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().
name | new name |
Reimplemented in FGOutputFile, and FGOutputSocket.
Definition at line 130 of file FGOutputType.h.
void SetOutputProperties | ( | std::vector< FGPropertyNode_ptr > & | outputProperties | ) |
Set the list of properties that should be output for this output instance.
outputProperties | list of properties that should be output |
Definition at line 224 of file FGOutputType.cpp.
void SetRateHz | ( | double | rtHz | ) |
Set the output rate for this output instances.
rtHz | new output rate in Hz |
Definition at line 203 of file FGOutputType.cpp.
|
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 166 of file FGOutputType.h.
|
inline |
Set the activated subsystems for this output instance.
subSystems | bitfield that describes the activated subsystems |
outputProperties | list of properties that should be output |
Definition at line 118 of file FGOutputType.h.
|
inline |
Toggles the output generation.
Definition at line 175 of file FGOutputType.h.
|
protected |
Definition at line 208 of file FGOutputType.h.
|
protected |
Definition at line 201 of file FGOutputType.h.
|
protected |
Definition at line 203 of file FGOutputType.h.
|
protected |
Definition at line 202 of file FGOutputType.h.
|
protected |
Definition at line 212 of file FGOutputType.h.
|
protected |
Definition at line 199 of file FGOutputType.h.
|
protected |
Definition at line 211 of file FGOutputType.h.
|
protected |
Definition at line 209 of file FGOutputType.h.
|
protected |
Definition at line 210 of file FGOutputType.h.
|
protected |
Definition at line 206 of file FGOutputType.h.
|
protected |
Definition at line 198 of file FGOutputType.h.
|
protected |
Definition at line 195 of file FGOutputType.h.
|
protected |
Definition at line 197 of file FGOutputType.h.
|
protected |
Definition at line 207 of file FGOutputType.h.
|
protected |
Definition at line 205 of file FGOutputType.h.
|
protected |
Definition at line 196 of file FGOutputType.h.
|
protected |
Definition at line 204 of file FGOutputType.h.