FlightGear: JSBSim::FGFCSComponent Class Reference

Base class for JSBSim Flight Control System Components. More...

#include <FGFCSComponent.h>

Inherited by JSBSim::FGActuator, JSBSim::FGAngles, JSBSim::FGDeadBand, JSBSim::FGDistributor, JSBSim::FGFCSFunction, JSBSim::FGFilter, JSBSim::FGGain, JSBSim::FGKinemat, JSBSim::FGLinearActuator, JSBSim::FGPID, JSBSim::FGSensor, JSBSim::FGSummer, JSBSim::FGSwitch, and JSBSim::FGWaypoint.

Public Member Functions
	FGFCSComponent (FGFCS fcs, Element el)
	Constructor.

virtual	~FGFCSComponent ()
	Destructor.

virtual bool	Run (void)

virtual void	SetOutput (void)

double	GetOutput (void) const

std::string	GetName (void) const

std::string	GetType (void) const

virtual double	GetOutputPct (void) const

virtual void	ResetPastStates (void)

Public Member Functions inherited from JSBSim::FGJSBBase
	FGJSBBase ()
	Constructor for FGJSBBase.

virtual	~FGJSBBase ()
	Destructor for FGJSBBase.

void	PutMessage (const Message &msg)
	Places a Message structure on the Message queue.

void	PutMessage (const std::string &text)
	Creates a message with the given text and places it on the queue.

void	PutMessage (const std::string &text, bool bVal)
	Creates a message with the given text and boolean value and places it on the queue.

void	PutMessage (const std::string &text, int iVal)
	Creates a message with the given text and integer value and places it on the queue.

void	PutMessage (const std::string &text, double dVal)
	Creates a message with the given text and double value and places it on the queue.

int	SomeMessages (void) const
	Reads the message on the queue (but does not delete it).

void	ProcessMessage (void)
	Reads the message on the queue and removes it from the queue.

Message *	ProcessNextMessage (void)
	Reads the next message on the queue and removes it from the queue.

void	disableHighLighting (void)
	Disables highlighting in the console output.

Protected Member Functions
void	Delay (void)

void	Clip (void)

void	CheckInputNodes (size_t MinNodes, size_t MaxNodes, Element *el)

virtual void	bind (Element *el)

virtual void	Debug (int from)

Protected Attributes
FGFCS *	fcs

FGPropertyManager *	PropertyManager

std::vector< FGPropertyNode_ptr >	OutputNodes

FGParameter_ptr	ClipMin

FGParameter_ptr	ClipMax

std::vector< FGPropertyValue_ptr >	InitNodes

std::vector< FGPropertyValue_ptr >	InputNodes

std::vector< double >	output_array

std::string	Type

std::string	Name

double	Input

double	Output

double	delay_time

unsigned int	delay

int	index

double	dt

bool	clip

bool	cyclic_clip

Additional Inherited Members
Public Types inherited from JSBSim::FGJSBBase
enum	{ eL = 1 , eM , eN }
	Moments L, M, N. More...

enum	{ eP = 1 , eQ , eR }
	Rates P, Q, R. More...

enum	{ eU = 1 , eV , eW }
	Velocities U, V, W. More...

enum	{ eX = 1 , eY , eZ }
	Positions X, Y, Z. More...

enum	{ ePhi = 1 , eTht , ePsi }
	Euler angles Phi, Theta, Psi. More...

enum	{ eDrag = 1 , eSide , eLift }
	Stability axis forces, Drag, Side force, Lift. More...

enum	{ eRoll = 1 , ePitch , eYaw }
	Local frame orientation Roll, Pitch, Yaw. More...

enum	{ eNorth = 1 , eEast , eDown }
	Local frame position North, East, Down. More...

enum	{ eLat = 1 , eLong , eRad }
	Locations Radius, Latitude, Longitude. More...

enum	{ inNone = 0 , inDegrees , inRadians , inMeters , inFeet }
	Conversion specifiers. More...

static const std::string &	GetVersion (void)
	Returns the version number of JSBSim.

static constexpr double	KelvinToFahrenheit (double kelvin)
	Converts from degrees Kelvin to degrees Fahrenheit.

static constexpr double	CelsiusToRankine (double celsius)
	Converts from degrees Celsius to degrees Rankine.

static constexpr double	RankineToCelsius (double rankine)
	Converts from degrees Rankine to degrees Celsius.

static constexpr double	KelvinToRankine (double kelvin)
	Converts from degrees Kelvin to degrees Rankine.

static constexpr double	RankineToKelvin (double rankine)
	Converts from degrees Rankine to degrees Kelvin.

static constexpr double	FahrenheitToCelsius (double fahrenheit)
	Converts from degrees Fahrenheit to degrees Celsius.

static constexpr double	CelsiusToFahrenheit (double celsius)
	Converts from degrees Celsius to degrees Fahrenheit.

static constexpr double	CelsiusToKelvin (double celsius)
	Converts from degrees Celsius to degrees Kelvin.

static constexpr double	KelvinToCelsius (double kelvin)
	Converts from degrees Kelvin to degrees Celsius.

static constexpr double	FeetToMeters (double measure)
	Converts from feet to meters.

static double	PitotTotalPressure (double mach, double p)
	Compute the total pressure in front of the Pitot tube.

static double	MachFromImpactPressure (double qc, double p)
	Compute the Mach number from the differential pressure (qc) and the static pressure.

static double	VcalibratedFromMach (double mach, double p)
	Calculate the calibrated airspeed from the Mach number.

static double	MachFromVcalibrated (double vcas, double p)
	Calculate the Mach number from the calibrated airspeed.Based on the formulas in the US Air Force Aircraft Performance Flight Testing Manual (AFFTC-TIH-99-01).

static bool	EqualToRoundoff (double a, double b)
	Finite precision comparison.

static bool	EqualToRoundoff (float a, float b)
	Finite precision comparison.

static bool	EqualToRoundoff (float a, double b)
	Finite precision comparison.

static bool	EqualToRoundoff (double a, float b)
	Finite precision comparison.

static constexpr double	Constrain (double min, double value, double max)
	Constrain a value between a minimum and a maximum value.

static constexpr double	sign (double num)

static double	GaussianRandomNumber (void)

Static Public Attributes inherited from JSBSim::FGJSBBase
static char	highint [5] = {27, '[', '1', 'm', '\0' }
	highlights text

static char	halfint [5] = {27, '[', '2', 'm', '\0' }
	low intensity text

static char	normint [6] = {27, '[', '2', '2', 'm', '\0' }
	normal intensity text

static char	reset [5] = {27, '[', '0', 'm', '\0' }
	resets text properties

static char	underon [5] = {27, '[', '4', 'm', '\0' }
	underlines text

static char	underoff [6] = {27, '[', '2', '4', 'm', '\0' }
	underline off

static char	fgblue [6] = {27, '[', '3', '4', 'm', '\0' }
	blue text

static char	fgcyan [6] = {27, '[', '3', '6', 'm', '\0' }
	cyan text

static char	fgred [6] = {27, '[', '3', '1', 'm', '\0' }
	red text

static char	fggreen [6] = {27, '[', '3', '2', 'm', '\0' }
	green text

static char	fgdef [6] = {27, '[', '3', '9', 'm', '\0' }
	default text

static short	debug_lvl = 1

static std::string	CreateIndexedPropertyName (const std::string &Property, int index)

static Message	localMsg

static std::queue< Message >	Messages

static unsigned int	messageId = 0

static constexpr double	radtodeg = 180. / 3.14159265358979323846

static constexpr double	degtorad = 3.14159265358979323846 / 180.

static constexpr double	hptoftlbssec = 550.0

static constexpr double	psftoinhg = 0.014138

static constexpr double	psftopa = 47.88

static constexpr double	ktstofps = 1.68781

static constexpr double	fpstokts = 1.0 / ktstofps

static constexpr double	inchtoft = 1.0/12.0

static constexpr double	fttom = 0.3048

static constexpr double	m3toft3 = 1.0/(fttomfttomfttom)

static constexpr double	in3tom3 = inchtoftinchtoftinchtoft/m3toft3

static constexpr double	inhgtopa = 3386.38

static constexpr double	slugtolb = 32.174049
	Note that definition of lbtoslug by the inverse of slugtolb and not to a different constant you can also get from some tables will make lbtoslug*slugtolb == 1 up to the magnitude of roundoff.

static constexpr double	lbtoslug = 1.0/slugtolb

static constexpr double	kgtolb = 2.20462

static constexpr double	kgtoslug = 0.06852168

static const std::string	needed_cfg_version = "2.0"

static const std::string	JSBSim_version = JSBSIM_VERSION " " __DATE__ " " __TIME__

static int	gaussian_random_number_phase = 0

Detailed Description

Base class for JSBSim Flight Control System Components.

The Flight Control System (FCS) for JSBSim consists of the FCS container class (see FGFCS), the FGFCSComponent base class, and the component classes from which can be constructed a string, or channel. See:

Author: Jon S. Berndt

See also: Documentation for the FGFCS class, and for the configuration file class

Definition at line 84 of file FGFCSComponent.h.

Constructor & Destructor Documentation

◆ FGFCSComponent()

JSBSim::FGFCSComponent::FGFCSComponent	(	FGFCS *	fcs,
		Element *	el )

Constructor.

Definition at line 52 of file FGFCSComponent.cpp.

◆ ~FGFCSComponent()

JSBSim::FGFCSComponent::~FGFCSComponent ( )

virtual

Destructor.

Definition at line 199 of file FGFCSComponent.cpp.

Member Function Documentation

◆ bind()

void JSBSim::FGFCSComponent::bind ( Element * el )

protectedvirtual

Reimplemented in JSBSim::FGSensor.

Definition at line 299 of file FGFCSComponent.cpp.

◆ CheckInputNodes()

void JSBSim::FGFCSComponent::CheckInputNodes	(	size_t	MinNodes,
		size_t	MaxNodes,
		Element *	el )

protected

Definition at line 215 of file FGFCSComponent.cpp.

◆ Clip()

void JSBSim::FGFCSComponent::Clip ( void )

protected

Definition at line 264 of file FGFCSComponent.cpp.

◆ Debug()

void JSBSim::FGFCSComponent::Debug ( int from )

protectedvirtual

Definition at line 344 of file FGFCSComponent.cpp.

◆ Delay()

void JSBSim::FGFCSComponent::Delay ( void )

protected

Definition at line 247 of file FGFCSComponent.cpp.

◆ GetName()

std::string JSBSim::FGFCSComponent::GetName ( void ) const

inline

Definition at line 95 of file FGFCSComponent.h.

◆ GetOutput()

double JSBSim::FGFCSComponent::GetOutput ( void ) const

inline

Definition at line 94 of file FGFCSComponent.h.

◆ GetOutputPct()

virtual double JSBSim::FGFCSComponent::GetOutputPct ( void ) const

inlinevirtual

Reimplemented in JSBSim::FGKinemat.

Definition at line 97 of file FGFCSComponent.h.

◆ GetType()

std::string JSBSim::FGFCSComponent::GetType ( void ) const

inline

Definition at line 96 of file FGFCSComponent.h.

◆ ResetPastStates()

void JSBSim::FGFCSComponent::ResetPastStates ( void )

virtual

Reimplemented in JSBSim::FGActuator, JSBSim::FGFilter, JSBSim::FGMagnetometer, JSBSim::FGPID, and JSBSim::FGSensor.

Definition at line 206 of file FGFCSComponent.cpp.

◆ Run()

virtual bool JSBSim::FGFCSComponent::Run ( void )

inlinevirtual

Reimplemented in JSBSim::FGAccelerometer, JSBSim::FGActuator, JSBSim::FGAngles, JSBSim::FGDeadBand, JSBSim::FGDistributor, JSBSim::FGFCSFunction, JSBSim::FGFilter, JSBSim::FGGain, JSBSim::FGGyro, JSBSim::FGKinemat, JSBSim::FGLinearActuator, JSBSim::FGMagnetometer, JSBSim::FGPID, JSBSim::FGSensor, JSBSim::FGSummer, JSBSim::FGSwitch, and JSBSim::FGWaypoint.

Definition at line 92 of file FGFCSComponent.h.

◆ SetOutput()

void JSBSim::FGFCSComponent::SetOutput ( void )

virtual

Definition at line 239 of file FGFCSComponent.cpp.

Member Data Documentation

◆ clip

bool JSBSim::FGFCSComponent::clip

protected

Definition at line 116 of file FGFCSComponent.h.

◆ ClipMax

FGParameter_ptr JSBSim::FGFCSComponent::ClipMax

protected

Definition at line 104 of file FGFCSComponent.h.

◆ ClipMin

FGParameter_ptr JSBSim::FGFCSComponent::ClipMin

protected

Definition at line 104 of file FGFCSComponent.h.

◆ cyclic_clip

bool JSBSim::FGFCSComponent::cyclic_clip

protected

Definition at line 116 of file FGFCSComponent.h.

◆ delay

unsigned int JSBSim::FGFCSComponent::delay

protected

Definition at line 113 of file FGFCSComponent.h.

◆ delay_time

double JSBSim::FGFCSComponent::delay_time

protected

Definition at line 112 of file FGFCSComponent.h.

◆ dt

double JSBSim::FGFCSComponent::dt

protected

Definition at line 115 of file FGFCSComponent.h.

◆ fcs

FGFCS* JSBSim::FGFCSComponent::fcs

protected

Definition at line 101 of file FGFCSComponent.h.

◆ index

int JSBSim::FGFCSComponent::index

protected

Definition at line 114 of file FGFCSComponent.h.

◆ InitNodes

std::vector<FGPropertyValue_ptr> JSBSim::FGFCSComponent::InitNodes

protected

Definition at line 105 of file FGFCSComponent.h.

◆ Input

double JSBSim::FGFCSComponent::Input

protected

Definition at line 110 of file FGFCSComponent.h.

◆ InputNodes

std::vector<FGPropertyValue_ptr> JSBSim::FGFCSComponent::InputNodes

protected

Definition at line 106 of file FGFCSComponent.h.

◆ Name

std::string JSBSim::FGFCSComponent::Name

protected

Definition at line 109 of file FGFCSComponent.h.

◆ Output

double JSBSim::FGFCSComponent::Output

protected

Definition at line 111 of file FGFCSComponent.h.

◆ output_array

std::vector<double> JSBSim::FGFCSComponent::output_array

protected

Definition at line 107 of file FGFCSComponent.h.

◆ OutputNodes

std::vector<FGPropertyNode_ptr> JSBSim::FGFCSComponent::OutputNodes

protected

Definition at line 103 of file FGFCSComponent.h.

◆ PropertyManager

FGPropertyManager* JSBSim::FGFCSComponent::PropertyManager

protected

Definition at line 102 of file FGFCSComponent.h.

◆ Type

std::string JSBSim::FGFCSComponent::Type

protected

Definition at line 108 of file FGFCSComponent.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FGFCSComponent()

◆ ~FGFCSComponent()

Member Function Documentation

◆ bind()

◆ CheckInputNodes()

◆ Clip()

◆ Debug()

◆ Delay()

◆ GetName()

◆ GetOutput()

◆ GetOutputPct()

◆ GetType()

◆ ResetPastStates()

◆ Run()

◆ SetOutput()

Member Data Documentation

◆ clip

◆ ClipMax

◆ ClipMin

◆ cyclic_clip

◆ delay

◆ delay_time

◆ dt

◆ fcs

◆ index

◆ InitNodes

◆ Input

◆ InputNodes

◆ Name

◆ Output

◆ output_array

◆ OutputNodes

◆ PropertyManager

◆ Type