FGKinemat Class Reference

#include <FGKinemat.h>

Inherits FGFCSComponent.

List of all members.

---

Detailed Description

This component models the action of a moving effector, such as an aerosurface or other mechanized entity such as a landing gear strut for the purpose of effecting vehicle control or configuration. The form of the component specification is:

<kinematic name="Gear Control">
  <input> [-]property </input>
  <traverse>
    <setting>
      <position> number </position>
      <time> number </time>
    </setting>
    ...
  </traverse>
  [<clipto>
    <min> {[-]property name | value} </min>
    <max> {[-]property name | value} </max>
  </clipto>]
  [<gain> {property name | value} </gain>]
  [<output> {property} </output>]
</kinematic>

The detent is the position that the component takes, and the lag is the time it takes to get to that position from an adjacent setting. For example:

<kinematic name="Gear Control">
  <input>gear/gear-cmd-norm</input>
  <traverse>
    <setting>
      <position>0</position>
      <time>0</time>
    </setting>
    <setting>
      <position>1</position>
      <time>5</time>
    </setting>
  </traverse>
  <output>gear/gear-pos-norm</output>
</kinematic>

In this case, it takes 5 seconds to get to a 1 setting. As this is a software mechanization of a servo-actuator, there should be an output specified.

Definition at line 116 of file FGKinemat.h.

Public Member Functions
	FGKinemat (FGFCS *fcs, Element *element)
	Constructor.
double	GetOutputPct () const
	Kinematic component output value.
bool	Run (void)
	Run method, overrides FGModel::Run().
	~FGKinemat ()
	Destructor.

---

Constructor & Destructor Documentation

FGKinemat	(	FGFCS *	fcs,
		Element *	element
	)

Parameters:

	fcs	A reference to the current flight control system.
	element	reference to the current configuration file node.

Definition at line 53 of file FGKinemat.cpp.

---

Member Function Documentation

double GetOutputPct

(

void

)

const [inline, virtual]

Returns:

the current output of the kinematic object on the range of [0,1].

Reimplemented from FGFCSComponent.

Definition at line 129 of file FGKinemat.h.

bool Run

(

void

)

[virtual]

Returns:

false on success, true on failure. The routine doing the work.

Reimplemented from FGFCSComponent.

Definition at line 99 of file FGKinemat.cpp.

---

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

• FGKinemat.h
• FGKinemat.cpp