FGTrimAnalysisControl Class Reference

#include <FGTrimAnalysisControl.h>

Inherits FGJSBBase.

List of all members.

---

Detailed Description

Definition at line 93 of file FGTrimAnalysisControl.h.

Public Member Functions
	FGTrimAnalysisControl (FGFDMExec *fdmex, FGInitialCondition *IC, TaControl control)
	Constructor for Trim Analysis Control class.
double	GetControl (void)
	Gets the control value.
double	GetControlInitialValue (void)
	Get control step.
double	GetControlMax (void)
	Gets the control maximum value.
double	GetControlMin (void)
	Gets the control minimum value.
string	GetControlName (void)
	Gets the control name.
double	GetControlStep (void)
	Get control step.
TaControl	GetControlType (void)
	Return the control type.
double	GetStateTarget (void)
	Get target state value for trim.
double	GetTolerance (void)
	Get control tolerance.
bool	initTheta (void)
	Calculate steady state thetas value on ground.
void	Run (void)
	This function iterates through a call to the FGFDMExec::RunIC() function until the desired trimming condition falls inside a tolerance.
void	SetControl (double value)
	Sets the control value.
void	SetControlInitialValue (double value)
	Set control initial value.
void	SetControlLimits (double min, double max)
	Set both control limits.
void	SetControlStep (double value)
	Set control step.
void	SetControlToMax (void)
	Set control value to maximum.
void	SetControlToMin (void)
	Set control value to minimum.
void	SetPhiOnGround (double ff)
	Set phi value on ground for trim.
void	SetStateTarget (double target)
	Set target state value for trim.
void	SetThetaOnGround (double ff)
	Set theta value on ground for trim.
void	SetTolerance (double ff)
	Set control tolerance.
	~FGTrimAnalysisControl ()
	Destructor.

---

Constructor & Destructor Documentation

FGTrimAnalysisControl	(	FGFDMExec *	fdmex,
		FGInitialCondition *	IC,
		TaControl	control
	)

Parameters:

	fdmex	FGFDMExec pointer
	IC	pointer to initial conditions instance
	control	a Control type (enum)

Definition at line 63 of file FGTrimAnalysisControl.cpp.

---

Member Function Documentation

double GetControl

(

void

)

[inline]

Returns:

value

Definition at line 122 of file FGTrimAnalysisControl.h.

double GetControlInitialValue

(

void

)

[inline]

Returns:

value of control initial value

Definition at line 163 of file FGTrimAnalysisControl.h.

double GetControlMax

(

void

)

[inline]

Returns:

control nax value

Definition at line 144 of file FGTrimAnalysisControl.h.

double GetControlMin

(

void

)

[inline]

Returns:

control min value

Definition at line 140 of file FGTrimAnalysisControl.h.

string GetControlName

(

void

)

[inline]

Returns:

control name

Definition at line 135 of file FGTrimAnalysisControl.h.

double GetControlStep

(

void

)

[inline]

Returns:

value of control step

Definition at line 153 of file FGTrimAnalysisControl.h.

TaControl GetControlType

(

void

)

[inline]

Returns:

TaControl

Definition at line 128 of file FGTrimAnalysisControl.h.

double GetStateTarget

(

void

)

[inline]

Returns:

state target

Definition at line 210 of file FGTrimAnalysisControl.h.

double GetTolerance

(

void

)

[inline]

Returns:

value of control tolerance

Definition at line 190 of file FGTrimAnalysisControl.h.

bool initTheta

(

void

)

Returns:

true if successful

Definition at line 329 of file FGTrimAnalysisControl.cpp.

void Run

(

void

)

Definition at line 428 of file FGTrimAnalysisControl.cpp.

void SetControl

(

double

value

)

[inline]

Parameters:

value

Definition at line 117 of file FGTrimAnalysisControl.h.

void SetControlInitialValue

(

double

value

)

[inline]

Parameters:

value

of control initial value

Definition at line 158 of file FGTrimAnalysisControl.h.

void SetControlLimits	(	double	min,
		double	max
	)			[inline]

Parameters:

	max	control max
	min	control min

Definition at line 177 of file FGTrimAnalysisControl.h.

void SetControlStep

(

double

value

)

[inline]

Parameters:

value

of control step

Definition at line 149 of file FGTrimAnalysisControl.h.

void SetPhiOnGround

(

double

ff

)

Parameters:

ff

Definition at line 399 of file FGTrimAnalysisControl.cpp.

void SetStateTarget

(

double

target

)

[inline]

Parameters:

target

Definition at line 205 of file FGTrimAnalysisControl.h.

void SetThetaOnGround

(

double

ff

)

Parameters:

ff

Definition at line 290 of file FGTrimAnalysisControl.cpp.

void SetTolerance

(

double

ff

)

[inline]

Parameters:

ff

value of control tolerance

Definition at line 185 of file FGTrimAnalysisControl.h.

---

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

• FGTrimAnalysisControl.h
• FGTrimAnalysisControl.cpp