FGState Class Reference

#include <FGState.h>

Inherits FGJSBBase.

List of all members.

---

Detailed Description

Properties

• sim-time-sec (read only) cumulative simulation in seconds.

  Author:

  Jon S. Berndt

  Version:

  Revision

  1.13

Definition at line 88 of file FGState.h.

Public Member Functions
	FGState (FGFDMExec *)
	Constructor.
double	Getdt (void)
	Returns the simulation delta T.
double	Getsim_time (void) const
	Returns the cumulative simulation time in seconds.
double	IncrTime (void)
	Increments the simulation time.
void	Initialize (FGInitialCondition *FGIC)
	Initializes the simulation state based on parameters from an Initial Conditions object.
bool	IntegrationSuspended (void)
	Returns the simulation suspension state.
void	ResumeIntegration (void)
	Resumes the simulation by resetting delta T to the correct value.
void	Setdt (double delta_t)
	Sets the integration time step for the simulation executive.
double	Setsim_time (double cur_time)
	Sets the current sim time.
void	SuspendIntegration (void)
	Suspends the simulation and sets the delta T to zero.
	~FGState ()
	Destructor.

---

Constructor & Destructor Documentation

FGState

(

FGFDMExec *

fdex

)

Parameters:

Executive

a pointer to the parent executive object

Definition at line 56 of file FGState.cpp.

---

Member Function Documentation

double IncrTime

(

void

)

[inline]

Returns:

the new simulation time.

Definition at line 132 of file FGState.h.

void Initialize

(

FGInitialCondition *

FGIC

)

Parameters:

FGIC

pointer to an initial conditions object.

See also:

FGInitialConditions.

Definition at line 87 of file FGState.cpp.

bool IntegrationSuspended

(

void

)

[inline]

Returns:

true if suspended, false if executing

Definition at line 116 of file FGState.h.

void Setdt

(

double

delta_t

)

[inline]

Parameters:

delta_t

the time step in seconds.

Definition at line 128 of file FGState.h.

double Setsim_time

(

double

cur_time

)

[inline]

Parameters:

cur_time

the current time

Returns:

the current simulation time.

Definition at line 121 of file FGState.h.

---

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

• FGState.h
• FGState.cpp