FGGroundCallback Class Reference

This class provides callback slots to get ground specific data. More...

#include <FGGroundCallback.h>

Inheritance diagram for FGGroundCallback:

Collaboration diagram for FGGroundCallback:

Public Member Functions
virtual double	GetAGLevel (double t, const FGLocation &location, FGLocation &contact, FGColumnVector3 &normal, FGColumnVector3 &v, FGColumnVector3 &w) const =0
	Compute the altitude above ground. More...
virtual double	GetAGLevel (const FGLocation &location, FGLocation &contact, FGColumnVector3 &normal, FGColumnVector3 &v, FGColumnVector3 &w) const
	Compute the altitude above ground. More...
virtual double	GetAltitude (const FGLocation &l) const =0
	Compute the altitude above sealevel. More...
virtual double	GetSeaLevelRadius (const FGLocation &location) const =0
	Return the sea level radius. More...
virtual double	GetTerrainGeoCentRadius (double t, const FGLocation &location) const =0
	Compute the local terrain radius. More...
virtual double	GetTerrainGeoCentRadius (const FGLocation &location) const
	Compute the local terrain radius. More...
virtual void	SetSeaLevelRadius (double radius)
	Set the sea level radius. More...
virtual void	SetTerrainGeoCentRadius (double radius)
	Set the local terrain radius. More...
void	SetTime (double _time)

Detailed Description

This class provides callback slots to get ground specific data.

The default implementation returns values for a ball formed earth with an adjustable terrain elevation.

Author

Mathias Froehlich

Version

Id

FGGroundCallback.h,v 1.18 2014/11/30 12:35:32 bcoconni Exp

Definition at line 72 of file FGGroundCallback.h.

Member Function Documentation

GetAGLevel() [1/2]

virtual double GetAGLevel ( double  t, const FGLocation &  location, FGLocation &  contact, FGColumnVector3 &  normal, FGColumnVector3 &  v, FGColumnVector3 &  w  ) const

pure virtual

Compute the altitude above ground.

The altitude depends on time t and location l.

Parameters

t	simulation time
l	location
contact	Contact point location below the location l
normal	Normal vector at the contact point
v	Linear velocity at the contact point
w	Angular velocity at the contact point

Returns

altitude above ground

Implemented in FGDefaultGroundCallback.

Here is the caller graph for this function:

GetAGLevel() [2/2]

virtual double GetAGLevel ( const FGLocation &  location, FGLocation &  contact, FGColumnVector3 &  normal, FGColumnVector3 &  v, FGColumnVector3 &  w  ) const

inlinevirtual

Compute the altitude above ground.

The altitude depends on location l.

Parameters

l	location
contact	Contact point location below the location l
normal	Normal vector at the contact point
v	Linear velocity at the contact point
w	Angular velocity at the contact point

Returns

altitude above ground

Definition at line 108 of file FGGroundCallback.h.

  { return GetAGLevel(time, location, contact, normal, v, w); }

Here is the call graph for this function:

GetAltitude()

virtual double GetAltitude ( const FGLocation &  l ) const

pure virtual

Compute the altitude above sealevel.

Parameters

l

location

Implemented in FGDefaultGroundCallback.

GetSeaLevelRadius()

virtual double GetSeaLevelRadius ( const FGLocation &  location ) const

pure virtual

Return the sea level radius.

Parameters

location

location

Implemented in FGDefaultGroundCallback.

Here is the caller graph for this function:

GetTerrainGeoCentRadius() [1/2]

virtual double GetTerrainGeoCentRadius ( double  t, const FGLocation &  location  ) const

pure virtual

Compute the local terrain radius.

Parameters

t	simulation time
location	location

Implemented in FGDefaultGroundCallback.

Here is the caller graph for this function:

GetTerrainGeoCentRadius() [2/2]

virtual double GetTerrainGeoCentRadius ( const FGLocation &  location ) const

inlinevirtual

Compute the local terrain radius.

Parameters

location

location

Definition at line 122 of file FGGroundCallback.h.

  { return GetTerrainGeoCentRadius(time, location); }

Here is the call graph for this function:

SetSeaLevelRadius()

virtual void SetSeaLevelRadius ( double  radius )

inlinevirtual

Set the sea level radius.

Only needs to be implemented if JSBSim should be allowed to modify the sea level radius (see the default implementation)

Reimplemented in FGDefaultGroundCallback.

Definition at line 140 of file FGGroundCallback.h.

{  }

Here is the caller graph for this function:

SetTerrainGeoCentRadius()

virtual void SetTerrainGeoCentRadius ( double  radius )

inlinevirtual

Set the local terrain radius.

Only needs to be implemented if JSBSim should be allowed to modify the local terrain radius (see the default implementation)

Reimplemented in FGDefaultGroundCallback.

Definition at line 134 of file FGGroundCallback.h.

{ }

Here is the caller graph for this function:

---

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

• FGGroundCallback.h