FGActuator Class Reference

#include <FGActuator.h>

Inherits FGFCSComponent.

List of all members.

---

Detailed Description

The actuator can be modeled as a "perfect actuator", with the Output being set directly to the input. The actuator can be made more "real" by specifying any/all of the following additional effects that can be applied to the actuator. In order of application to the input signal, these are:

• System lag (input lag, really)
• Rate limiting
• Deadband
• Hysteresis (mechanical hysteresis)
• Bias (mechanical bias)
• Position limiting ("hard stops")

There are also several malfunctions that can be applied to the actuator by setting a property to true or false (or 1 or 0).

Syntax:

<actuator name="name">
  <input> {[-]property} </input>
  <lag> number </lag>
  <rate_limit> number <rate_limit>
  <bias> number </bias>
  <deadband_width> number </deadband_width>
  <hysteresis_width> number </hysteresis_width>
  [<clipto>
    <min> {property name | value} </min>
    <max> {property name | value} </max>
   </clipto>]
  [<output> {property} </output>]
</actuator>

Example:

<actuator name="fcs/gimbal_pitch_position">
  <input> fcs/gimbal_pitch_command </input>
  <lag> 60 </lag>
  <rate_limit> 0.085 <rate_limit> <!-- 5 degrees/sec -->
  <bias> 0.002 </bias>
  <deadband_width> 0.002 </deadband_width>
  <hysteresis_width> 0.05 </hysteresis_width>
  <clipto> <!-- +/- 10 degrees -->
    <min> -0.17 </min>
    <max>  0.17 </max>
   </clipto>
</actuator>

Author:

Jon S. Berndt

Version:

Revision

1.8

Definition at line 121 of file FGActuator.h.

Public Member Functions
	FGActuator (FGFCS *fcs, Element *element)
	Constructor.
bool	GetFailHardover (void) const
bool	GetFailStuck (void) const
bool	GetFailZero (void) const
bool	Run (void)
	This function processes the input.
void	SetFailHardover (bool set)
void	SetFailStuck (bool set)
void	SetFailZero (bool set)
	This function fails the actuator to zero.
	~FGActuator ()
	Destructor.

---

Member Function Documentation

bool Run

(

void

)

[virtual]

It calls private functions if needed to perform the hysteresis, lag, limiting, etc. functions.

Reimplemented from FGFCSComponent.

Definition at line 102 of file FGActuator.cpp.

void SetFailZero

(

bool

set

)

[inline]

The motion to zero will flow through the lag, hysteresis, and rate limiting functions if those are activated.

Definition at line 138 of file FGActuator.h.

---

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

• FGActuator.h
• FGActuator.cpp