Collaboration diagram for Objective:

Public Types
typedef void(*	PF) (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
	Pointer to cost function implementation.

Public Member Functions
	Objective (FGFDMExec fdmex, FGTrimAnalysis ta, double x)
	Constructor.

	~Objective ()
	Destructor.

void	CostFunctionFull (long vars, Vector< double > &v, double &f)
	Full Trim cost function. More...

void	CostFunctionFullCoordinatedTurn (long vars, Vector< double > &v, double &f)
	Steady Turn Trim cost function, NON-coordinated. More...

void	CostFunctionFullTurn (long vars, Vector< double > &v, double &f)
	Steady Turn Trim cost function. More...

void	CostFunctionFullWingsLevel (long vars, Vector< double > &v, double &f)
	Wings Level Trim cost function. More...

void	CostFunctionLongitudinal (long vars, Vector< double > &v, double &f)
	Longitudinal Trim cost function. More...

void	CostFunctionPullUp (long vars, Vector< double > &v, double &f)
	Pullup Trim cost function. More...

double	Get_x_val () const

void	Set_x_val (double new_x)

Public Attributes
map< TrimAnalysisMode, PF >	mpCostFunctions

Friends
void	find_CostFunctionFull (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
	Wrapping function for the effective Full Trim cost function, to be called by optimization method. More...

void	find_CostFunctionFullCoordinatedTurn (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
	Wrapping function for the effective Steady Turn Trim cost function, to be called by optimization method. More...

void	find_CostFunctionFullTurn (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
	Wrapping function for the effective Steady Turn Trim cost function, to be called by optimization method. More...

void	find_CostFunctionFullWingsLevel (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
	Wrapping function for the effective Wings Level Trim cost function, to be called by optimization method. More...

void	find_CostFunctionLongitudinal (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
	Wrapping function for the effective Longitudinal Trim cost function, to be called by optimization method. More...

void	find_CostFunctionPullUp (long vars, Vector< double > &v, double &f, bool &success, void *t_ptr)
	Wrapping function for the effective Pullup Trim cost function, to be called by optimization method. More...

Detailed Description

Definition at line 129 of file FGTrimAnalysis.h.

Member Function Documentation

◆ CostFunctionFull()

void CostFunctionFull	(	long	vars,
		Vector< double > &	v,
		double &	f
	)

Full Trim cost function.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value

Note: the effective cost function evaluation is performed in a private function

Definition at line 220 of file FGTrimAnalysis.cpp.

 {
   if (vars != 7) {
       cerr << "\nError: (Cost function for taFull mode) Dimension must be 7 !!\n";
       exit(1);
   }
   if (TrimAnalysis->GetMode()!=taFull){
       cerr << "\nError: must be taFull mode !!\n";
       exit(1);
   }
 
   f = myCostFunctionFull(v);
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CostFunctionFullCoordinatedTurn()

void CostFunctionFullCoordinatedTurn	(	long	vars,
		Vector< double > &	v,
		double &	f
	)

Steady Turn Trim cost function, NON-coordinated.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value

Note: the effective cost function evaluation is performed in a private function

Definition at line 265 of file FGTrimAnalysis.cpp.

 {
   if (vars != 5) {
       cerr << "\nError: (Cost function for taTurn mode) Dimension must be 5 !!\n";
       exit(1);
   }
   if (TrimAnalysis->GetMode()!=taTurn){
       cerr << "\nError: trim mode must be taTurn mode !!\n";
       exit(1);
   }
 
   f = myCostFunctionFullCoordinatedTurn(v);
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CostFunctionFullTurn()

void CostFunctionFullTurn	(	long	vars,
		Vector< double > &	v,
		double &	f
	)

Steady Turn Trim cost function.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value

Note: the effective cost function evaluation is performed in a private function

Definition at line 280 of file FGTrimAnalysis.cpp.

 {
   if (vars != 6) {
       cerr << "\nError: (Cost function for taTurn mode) Dimension must be 6 !!\n";
       exit(1);
   }
   if (TrimAnalysis->GetMode()!=taTurnFull){
       cerr << "\nError: trim mode must be taTurnFull ("<< (int)taTurnFull << ") mode !!\n";
       exit(1);
   }
 
   f = myCostFunctionFullTurn(v);
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CostFunctionFullWingsLevel()

void CostFunctionFullWingsLevel	(	long	vars,
		Vector< double > &	v,
		double &	f
	)

Wings Level Trim cost function.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value

Note: the effective cost function evaluation is performed in a private function

Definition at line 235 of file FGTrimAnalysis.cpp.

 {
   if (vars != 6) {
       cerr << "\nError: (Cost function for taFullWingsLevel mode) Dimension must be 6 !!\n";
       exit(1);
   }
   if (TrimAnalysis->GetMode()!=taFullWingsLevel){
       cerr << "\nError: must be taFull mode !!\n";
       exit(1);
   }
 
   f = myCostFunctionFullWingsLevel(v);
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CostFunctionLongitudinal()

void CostFunctionLongitudinal	(	long	vars,
		Vector< double > &	v,
		double &	f
	)

Longitudinal Trim cost function.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value

Note: the effective cost function evaluation is performed in a private function

Definition at line 250 of file FGTrimAnalysis.cpp.

 {
   if (vars != 3) {
       cerr << "\nError: (Cost function for taLongitudinal mode) Dimension must be 3 !!\n";
       exit(1);
   }
   if (TrimAnalysis->GetMode()!=taLongitudinal){
       cerr << "\nError: trim mode must be taLongitudinal mode !!\n";
       exit(1);
   }
 
   f = myCostFunctionLongitudinal(v);
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CostFunctionPullUp()

void CostFunctionPullUp	(	long	vars,
		Vector< double > &	v,
		double &	f
	)

Pullup Trim cost function.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value

Note: the effective cost function evaluation is performed in a private function

Definition at line 295 of file FGTrimAnalysis.cpp.

 {
   if (vars != 5) {
       cerr << "\nError: (Cost function for taPullup mode) Dimension must be 5 !!\n";
       exit(1);
   }
   if (TrimAnalysis->GetMode()!=taPullup){
       cerr << "\nError: trim mode must be taPullup mode !!\n";
       exit(1);
   }
 
   f = myCostFunctionPullUp(v);
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ find_CostFunctionFull

void find_CostFunctionFull	(	long	vars,
		Vector< double > &	v,
		double &	f,
		bool &	success,
		void *	t_ptr
	)

friend

Wrapping function for the effective Full Trim cost function, to be called by optimization method.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value
success
t_ptr	the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.

Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 106 of file FGTrimAnalysis.cpp.

     {
         (*(Objective*)t_ptr).CostFunctionFull(vars, v, f);
         success = true;
     }

◆ find_CostFunctionFullCoordinatedTurn

void find_CostFunctionFullCoordinatedTurn	(	long	vars,
		Vector< double > &	v,
		double &	f,
		bool &	success,
		void *	t_ptr
	)

friend

Wrapping function for the effective Steady Turn Trim cost function, to be called by optimization method.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value
success
t_ptr	the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.

Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 163 of file FGTrimAnalysis.cpp.

     {
         (*(Objective*)t_ptr).CostFunctionFullCoordinatedTurn(vars, v, f);
         success = true;
     }

◆ find_CostFunctionFullTurn

void find_CostFunctionFullTurn	(	long	vars,
		Vector< double > &	v,
		double &	f,
		bool &	success,
		void *	t_ptr
	)

friend

Wrapping function for the effective Steady Turn Trim cost function, to be called by optimization method.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value
success
t_ptr	the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.

Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 182 of file FGTrimAnalysis.cpp.

     {
         (*(Objective*)t_ptr).CostFunctionFullTurn(vars, v, f);
         success = true;
     }

◆ find_CostFunctionFullWingsLevel

void find_CostFunctionFullWingsLevel	(	long	vars,
		Vector< double > &	v,
		double &	f,
		bool &	success,
		void *	t_ptr
	)

friend

Wrapping function for the effective Wings Level Trim cost function, to be called by optimization method.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value
success
t_ptr	the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.

Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 125 of file FGTrimAnalysis.cpp.

     {
         (*(Objective*)t_ptr).CostFunctionFullWingsLevel(vars, v, f);
         success = true;
     }

◆ find_CostFunctionLongitudinal

void find_CostFunctionLongitudinal	(	long	vars,
		Vector< double > &	v,
		double &	f,
		bool &	success,
		void *	t_ptr
	)

friend

Wrapping function for the effective Longitudinal Trim cost function, to be called by optimization method.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value
success
t_ptr	the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.

Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 144 of file FGTrimAnalysis.cpp.

     {
         (*(Objective*)t_ptr).CostFunctionLongitudinal(vars, v, f);
         success = true;
     }

◆ find_CostFunctionPullUp

void find_CostFunctionPullUp	(	long	vars,
		Vector< double > &	v,
		double &	f,
		bool &	success,
		void *	t_ptr
	)

friend

Wrapping function for the effective Pullup Trim cost function, to be called by optimization method.

Parameters

vars	number ofcontrol varables
v	reference to a vector containing controls variables
f	function value
success
t_ptr	the following method is friend rather then member of FGTrimAnalysis because we want our FGTrimAnalysis::DoTrim() to be able to pass pointers to it.

Note that in the call masked by this methods, the void pointer should be cast to a pointer of the class type.

Definition at line 201 of file FGTrimAnalysis.cpp.

     {
         (*(Objective*)t_ptr).CostFunctionPullUp(vars, v, f);
         success = true;
     }

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

Public Types

Public Member Functions

Public Attributes

Friends

Detailed Description

Member Function Documentation

◆ CostFunctionFull()

◆ CostFunctionFullCoordinatedTurn()

◆ CostFunctionFullTurn()

◆ CostFunctionFullWingsLevel()

◆ CostFunctionLongitudinal()

◆ CostFunctionPullUp()

Friends And Related Function Documentation

◆ find_CostFunctionFull

◆ find_CostFunctionFullCoordinatedTurn

◆ find_CostFunctionFullTurn

◆ find_CostFunctionFullWingsLevel

◆ find_CostFunctionLongitudinal

◆ find_CostFunctionPullUp