FGOutput Class Reference

#include <FGOutput.h>

Inherits FGModel, and FGXMLFileRead.

List of all members.

---

Detailed Description

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. NOT IMPLEMENTED YET!
      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>

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

Version:

Id

FGOutput.h,v 1.13 2009/03/25 12:02:49 jberndt Exp

Definition at line 134 of file FGOutput.h.

Public Types
enum	eSubSystems {   ssSimulation = 1, ssAerosurfaces = 2, ssRates = 4, ssVelocities = 8,   ssForces = 16, ssMoments = 32, ssAtmosphere = 64, ssMassProps = 128,   ssCoefficients = 256, ssPropagate = 512, ssGroundReactions = 1024, ssFCS = 2048,   ssPropulsion = 4096 }
	Subsystem types for specifying which will be output in the FDM data logging. More...
Public Member Functions
void	DelimitedOutput (string)
void	Disable (void)
void	Enable (void)
	FGOutput (FGFDMExec *)
void	FlightGearSocketOutput (void)
string	GetOutputFileName (void) const
bool	InitModel (void)
bool	Load (Element *el)
	Loads this model.
bool	Run (void)
	Runs the model; called by the Executive.
void	SetDirectivesFile (string fname)
void	SetOutputFileName (string fname)
void	SetStartNewFile (bool tt)
void	SetSubsystems (int tt)
void	SetType (string)
void	SocketDataFill (FGNetFDM *net)
void	SocketOutput (void)
void	SocketStatusOutput (string)
bool	Toggle (void)
Public Attributes
FGNetFDM	fgSockBuf
enum JSBSim::FGOutput::eSubSystems	subsystems

---

Member Enumeration Documentation

enum eSubSystems

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).
ssCoefficients	Subsystem: Coefficients (= 256).
ssPropagate	Subsystem: Propagate (= 512).
ssGroundReactions	Subsystem: Ground Reactions (= 1024).
ssFCS	Subsystem: FCS (= 2048).
ssPropulsion	Subsystem: Propulsion (= 4096).

Definition at line 162 of file FGOutput.h.

---

Member Function Documentation

bool Load

(

Element *

el

)

[virtual]

Parameters:

el

a pointer to the element

Returns:

true if model is successfully loaded

Reimplemented from FGModel.

Definition at line 933 of file FGOutput.cpp.

bool Run

(

void

)

[virtual]

See also:

JSBSim.cpp documentation

Returns:

false if no error

Reimplemented from FGModel.

Definition at line 184 of file FGOutput.cpp.

---

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

• FGOutput.h
• FGOutput.cpp