wsf::EarthGravityModelExtension Class Reference

The Earth Gravitational Model (EGM) scenario extension. More...

#include <WsfEarthGravityModel.hpp>

Inheritance diagram for wsf::EarthGravityModelExtension:

Collaboration diagram for wsf::EarthGravityModelExtension:

Public Types
enum	EGMComplianceType { cEGM_UNKNOWN , cEGM2008 , cEGM96 }

Public Member Functions
	EarthGravityModelExtension ()=default
	EarthGravityModelExtension (const EarthGravityModelExtension &aSrc)=default
	~EarthGravityModelExtension () override=default
bool	Complete () override
void	SimulationCreated (WsfSimulation &aSimulation) override
bool	ProcessInput (UtInput &aInput) override
float	GetGeoidUndulation (double aLat, double aLon) const
EGMComplianceType	GetEGM_ComplianceType () const
bool	IsEGM2008Compliant () const
bool	IsEGM96Compliant () const
bool	IsEGM_Unknown () const
Public Member Functions inherited from WsfScenarioExtension
	WsfScenarioExtension ()
	~WsfScenarioExtension () override
WsfScenario &	GetScenario () const
WsfApplication &	GetApplication () const
virtual void	AddedToScenario ()
virtual void	FileLoaded (const std::string &aFileName)
virtual bool	Complete2 ()
virtual bool	AlwaysCreate ()
Public Member Functions inherited from WsfExtension
virtual	~WsfExtension ()=default
const std::string &	GetExtensionName () const

Static Public Member Functions
static EarthGravityModelExtension &	Get (const WsfScenario &aScenario)

Additional Inherited Members
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)

Detailed Description

The Earth Gravitational Model (EGM) scenario extension.

Member Enumeration Documentation

EGMComplianceType

enum wsf::EarthGravityModelExtension::EGMComplianceType

Enumerator
cEGM_UNKNOWN
cEGM2008
cEGM96

Constructor & Destructor Documentation

EarthGravityModelExtension() [1/2]

wsf::EarthGravityModelExtension::EarthGravityModelExtension ( )

default

Referenced by EarthGravityModelExtension(), Get(), and ~EarthGravityModelExtension().

EarthGravityModelExtension() [2/2]

wsf::EarthGravityModelExtension::EarthGravityModelExtension ( const EarthGravityModelExtension & aSrc )

default

References EarthGravityModelExtension().

~EarthGravityModelExtension()

wsf::EarthGravityModelExtension::~EarthGravityModelExtension ( )

overridedefault

References Complete(), EarthGravityModelExtension(), Get(), GetGeoidUndulation(), ProcessInput(), SimulationCreated(), and WsfScenarioExtension::WsfScenario.

Member Function Documentation

Complete()

bool wsf::EarthGravityModelExtension::Complete ( )

overridevirtual

Called when all inputs are processed. This is called when the application calls WsfScenario::LoadComplete to signify that all input data has been loaded into the scenario. The extension should perform any additional validity checking or other processing on its input data. Constant data may be created and stored here. Unless Complete2() is also implement, the contents of this class should not be changed after this call.

The extension should not assume anything about the state of another extension unless this a dependency has been registered to ensure the other extension has been called prior to this, e.g.:

app.ExtensionDepends("my_ext", "other_ext");

Returns

'true' if no problems or 'false' if an error occurred that would prevent execution.

Reimplemented from WsfScenarioExtension.

References cEGM2008, and ok.

Referenced by ~EarthGravityModelExtension().

Get()

EarthGravityModelExtension & wsf::EarthGravityModelExtension::Get ( const WsfScenario & aScenario )

static

References EarthGravityModelExtension(), WsfScenario::FindExtension(), WsfScenarioExtension::WsfScenario, and WsfScenarioExtension::WsfScenarioExtension().

Referenced by WsfDisInterface::ExtrapolatePlatformState(), WsfDisPlatform::MoverUpdated(), wsf::TerrainInterface::ProcessInput(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), and ~EarthGravityModelExtension().

GetEGM_ComplianceType()

EGMComplianceType wsf::EarthGravityModelExtension::GetEGM_ComplianceType ( ) const

inline

GetGeoidUndulation()

float wsf::EarthGravityModelExtension::GetGeoidUndulation	(	double	aLat,
		double	aLon ) const

Referenced by WsfDisInterface::ExtrapolatePlatformState(), WsfDisPlatform::MoverUpdated(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), and ~EarthGravityModelExtension().

IsEGM2008Compliant()

bool wsf::EarthGravityModelExtension::IsEGM2008Compliant ( ) const

inline

References cEGM2008.

IsEGM96Compliant()

bool wsf::EarthGravityModelExtension::IsEGM96Compliant ( ) const

inline

References cEGM96.

IsEGM_Unknown()

bool wsf::EarthGravityModelExtension::IsEGM_Unknown ( ) const

inline

References cEGM_UNKNOWN.

ProcessInput()

bool wsf::EarthGravityModelExtension::ProcessInput ( UtInput & aInput )

overridevirtual

Process the gravity_model block.

Parameters

aInput

[input] The input stream.

Returns

'true' if the command was recognized (and processed) or 'false' if the command was not one recognized by this class.

Reimplemented from WsfScenarioExtension.

Referenced by ~EarthGravityModelExtension().

SimulationCreated()

void wsf::EarthGravityModelExtension::SimulationCreated ( WsfSimulation & aSimulation )

overridevirtual

Called when a simulation has been created. (Technically this is called upon entry to WsfSimulation::Initialize()). This is typically used when a scenario extension also requires a simulation extension. The method would typically register the simulation extension as follows:

aSimulation.RegisterExtension("my_ext", new MySimulationExtension());

Parameters

aSimulation

The simulation that is being created. See note below!

Note

This is called upon entry to WsfSimulation::Initialize() and nothing can be assumed about the state of the simulation.

See also

WsfSimulationExtension, WsfApplicationExtension::SimulationCreated

Reimplemented from WsfScenarioExtension.

References WsfExtension::GetExtensionName(), and WsfSimulation::RegisterExtension().

Referenced by ~EarthGravityModelExtension().

---

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

• WsfEarthGravityModel.hpp
• WsfEarthGravityModel.cpp