JSBSim::FGSurface Class Reference

Base class for all surface properties. More...

#include <FGSurface.h>

Inherited by JSBSim::FGGroundReactions, and JSBSim::FGLGear [protected].

Public Types
enum	ContactType { ctBOGEY , ctSTRUCTURE , ctGROUND }

Public Member Functions
	FGSurface (FGFDMExec *fdmex, int number=-1)
	Constructor.
	~FGSurface ()
	Destructor.
void	bind (void)
void	resetValues (void)
	Reset all surface values to a default.
void	SetStaticFFactor (double friction)
	Sets the static friction factor of the surface area.
void	SetRollingFFactor (double friction)
	Sets the rolling friction factor of the surface area.
void	SetMaximumForce (double force)
	Sets the maximum force for the surface area.
void	SetBumpiness (double bump)
	Sets the normalized bumpiness factor associated with the surface.
void	SetSolid (bool solid)
	Sets the surface is a solid flag value.
void	SetPosition (const double pt[3])
	Set the currect position for bumpiness calulcation.
void	SetBumpHeight (float height)
	Sets the height of the bump at the provided offset.
double	GetStaticFFactor (void)
	Gets the static friction factor of the surface area.
double	GetRollingFFactor (void)
	Gets the rolling friction factor of the surface area.
double	GetMaximumForce (void)
	Gets the maximum force of the surface area.
double	GetBumpiness (void)
	Gets the normalized bumpiness factor associated with the surface.
bool	GetSolid (void)
	Gets the surface is a solid flag value.
float	GetBumpHeight ()
	Returns the height of the bump at the provided offset.
std::string	GetSurfaceStrings (std::string delimeter) const
std::string	GetSurfaceValues (std::string delimeter) const

Protected Attributes
ContactType	eSurfaceType = ctBOGEY
double	staticFFactor = 1.0
double	rollingFFactor = 1.0
double	maximumForce = DBL_MAX
double	bumpiness = 0.0
bool	isSolid = true
double	staticFCoeff = 1.0
double	dynamicFCoeff = 1.0

Detailed Description

Base class for all surface properties.

Author

Erik M. Hofman

Definition at line 61 of file FGSurface.h.

Member Enumeration Documentation

ContactType

enum JSBSim::FGSurface::ContactType

Enumerator
ctBOGEY
ctSTRUCTURE
ctGROUND

Definition at line 65 of file FGSurface.h.

Constructor & Destructor Documentation

FGSurface()

JSBSim::FGSurface::FGSurface	(	FGFDMExec *	fdmex,
		int	number = -1 )

Constructor.

Definition at line 52 of file FGSurface.cpp.

~FGSurface()

JSBSim::FGSurface::~FGSurface

(

)

Destructor.

Definition at line 61 of file FGSurface.cpp.

Member Function Documentation

bind()

void JSBSim::FGSurface::bind

(

void

)

Definition at line 81 of file FGSurface.cpp.

GetBumpHeight()

float JSBSim::FGSurface::GetBumpHeight

(

)

Returns the height of the bump at the provided offset.

Definition at line 116 of file FGSurface.cpp.

GetBumpiness()

double JSBSim::FGSurface::GetBumpiness ( void )

inline

Gets the normalized bumpiness factor associated with the surface.

Definition at line 112 of file FGSurface.h.

GetMaximumForce()

double JSBSim::FGSurface::GetMaximumForce ( void )

inline

Gets the maximum force of the surface area.

Definition at line 109 of file FGSurface.h.

GetRollingFFactor()

double JSBSim::FGSurface::GetRollingFFactor ( void )

inline

Gets the rolling friction factor of the surface area.

Definition at line 106 of file FGSurface.h.

GetSolid()

bool JSBSim::FGSurface::GetSolid ( void )

inline

Gets the surface is a solid flag value.

Definition at line 115 of file FGSurface.h.

GetStaticFFactor()

double JSBSim::FGSurface::GetStaticFFactor ( void )

inline

Gets the static friction factor of the surface area.

Definition at line 103 of file FGSurface.h.

GetSurfaceStrings()

string JSBSim::FGSurface::GetSurfaceStrings

(

std::string

delimeter

)

const

Definition at line 155 of file FGSurface.cpp.

GetSurfaceValues()

string JSBSim::FGSurface::GetSurfaceValues

(

std::string

delimeter

)

const

Definition at line 170 of file FGSurface.cpp.

resetValues()

void JSBSim::FGSurface::resetValues

(

void

)

Reset all surface values to a default.

Definition at line 67 of file FGSurface.cpp.

SetBumpHeight()

void JSBSim::FGSurface::SetBumpHeight ( float height )

inline

Sets the height of the bump at the provided offset.

Definition at line 99 of file FGSurface.h.

SetBumpiness()

void JSBSim::FGSurface::SetBumpiness ( double bump )

inline

Sets the normalized bumpiness factor associated with the surface.

Definition at line 88 of file FGSurface.h.

SetMaximumForce()

void JSBSim::FGSurface::SetMaximumForce ( double force )

inline

Sets the maximum force for the surface area.

Definition at line 85 of file FGSurface.h.

SetPosition()

void JSBSim::FGSurface::SetPosition ( const double pt[3] )

inline

Set the currect position for bumpiness calulcation.

Definition at line 94 of file FGSurface.h.

SetRollingFFactor()

void JSBSim::FGSurface::SetRollingFFactor ( double friction )

inline

Sets the rolling friction factor of the surface area.

Definition at line 82 of file FGSurface.h.

SetSolid()

void JSBSim::FGSurface::SetSolid ( bool solid )

inline

Sets the surface is a solid flag value.

Definition at line 91 of file FGSurface.h.

SetStaticFFactor()

void JSBSim::FGSurface::SetStaticFFactor ( double friction )

inline

Sets the static friction factor of the surface area.

Definition at line 79 of file FGSurface.h.

Member Data Documentation

bumpiness

double JSBSim::FGSurface::bumpiness = 0.0

protected

Definition at line 128 of file FGSurface.h.

dynamicFCoeff

double JSBSim::FGSurface::dynamicFCoeff = 1.0

protected

Definition at line 132 of file FGSurface.h.

eSurfaceType

ContactType JSBSim::FGSurface::eSurfaceType = ctBOGEY

protected

Definition at line 124 of file FGSurface.h.

isSolid

bool JSBSim::FGSurface::isSolid = true

protected

Definition at line 129 of file FGSurface.h.

maximumForce

double JSBSim::FGSurface::maximumForce = DBL_MAX

protected

Definition at line 127 of file FGSurface.h.

rollingFFactor

double JSBSim::FGSurface::rollingFFactor = 1.0

protected

Definition at line 126 of file FGSurface.h.

staticFCoeff

double JSBSim::FGSurface::staticFCoeff = 1.0

protected

Definition at line 131 of file FGSurface.h.

staticFFactor

double JSBSim::FGSurface::staticFFactor = 1.0

protected

Definition at line 125 of file FGSurface.h.

---

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

• FGSurface.h
• FGSurface.cpp