wsf::six_dof::Environment Class Reference

#include <WsfSixDOF_Environment.hpp>

Inheritance diagram for wsf::six_dof::Environment:

Collaboration diagram for wsf::six_dof::Environment:

Public Member Functions
	Environment ()=default
	~Environment ()=default
void	AddedToScenario () override
bool	ProcessInput (UtInput &aInput) override
UtVec3dX	GetWindNED_mps (double aLatitude, double aLongitude, double aAltitude_m) const
double	GetTerrainElevation (double aLatitude, double aLongitude) const
double	GetTerrainDataElevationAndData (double aLatitude, double aLongitude, UtVec3dX &aUpVectorNED, UtVec3dX &aSpeedVectorNED_mps, double &aFrictionMultiplier) const
void	GetAeroParameters (double aAltitude_ft, double aSpeed_fps, double &aAirDensity, double &aDynamicPressure_psf, double &aStaticPressure_psf) const
double	CalcAirDensity_slug_ft3 (double aAltitude_ft) const
double	CalcAmbientPressure_psf (double aAltitude_ft) const
double	CalcKtasFromKcas (double aAltitude_m, double aSpeed_kcas) const
double	CalcKcasFromKtas (double aAltitude_m, double aSpeed_ktas) const
double	CalcKtasFromMach (double aAltitude_m, double aSpeed_mach) const
double	CalcMachFromKtas (double aAltitude_m, double aSpeed_ktas) const
double	CalcKcasFromMach (double aAltitude_m, double aSpeed_mach) const
double	CalcMachFromKcas (double aAltitude_m, double aSpeed_kcas) const
double	CalcKcasFromFps (double aAltitude_m, double aSpeed_fps) const
double	CalcFpsFromKcas (double aAltitude_m, double aSpeed_kcas) const
double	CalcMachFromFps (double aAltitude_m, double aSpeed_fps) const
double	CalcFpsFromMach (double aAltitude_m, double aSpeed_mach) const
double	CalcFpsFromDynamicPressure (double aAltitude_m, double aPressure_psf) const
double	CalcDynamicPressure_psf (double aAltitude_m, double aSpeed_fps) const
double	CalcDensityRatio (double aAltitude_m) const
bool	IsWithinContrailBand (double aAltitude_m) const
Public Member Functions inherited from WsfScenarioExtension
	WsfScenarioExtension ()
	~WsfScenarioExtension () override
WsfScenario &	GetScenario () const
WsfApplication &	GetApplication () const
virtual void	FileLoaded (const std::string &aFileName)
virtual bool	Complete ()
virtual bool	Complete2 ()
virtual void	SimulationCreated (WsfSimulation &aSimulation)
virtual bool	AlwaysCreate ()
Public Member Functions inherited from WsfExtension
virtual	~WsfExtension ()=default
const std::string &	GetExtensionName () const

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

Constructor & Destructor Documentation

Environment()

wsf::six_dof::Environment::Environment ( )

default

~Environment()

wsf::six_dof::Environment::~Environment ( )

default

Member Function Documentation

AddedToScenario()

void wsf::six_dof::Environment::AddedToScenario ( )

overridevirtual

Called when the extension has been added to the scenario. This is typically used to register new component type objects and object factories, e.g.:

WsfScenario& scenario(GetScenario());
WsfMoverTypes::Get(scenario).AddCoreType("MY_MOVER", new MyMover(scenario));
WsfAntennaPatterTypes::Get(scenario).AddObjectFactor(MyAntennaPattern::ObjectFactory);

Script classes must NOT be registered here because they are global to the entire application. They should be registered in WsfApplication::AddedToApplication.

Note

GetScenario() and GetApplication() are now valid.

Reimplemented from WsfScenarioExtension.

References WsfScenario::GetAtmosphere(), WsfScenario::GetEnvironment(), WsfScenarioExtension::GetScenario(), WsfScenario::GetTerrainInterface(), and WsfScenarioExtension::WsfScenario.

CalcAirDensity_slug_ft3()

double wsf::six_dof::Environment::CalcAirDensity_slug_ft3 ( double aAltitude_ft ) const

inline

Referenced by GetAeroParameters().

CalcAmbientPressure_psf()

double wsf::six_dof::Environment::CalcAmbientPressure_psf ( double aAltitude_ft ) const

inline

Referenced by GetAeroParameters().

CalcDensityRatio()

double wsf::six_dof::Environment::CalcDensityRatio ( double aAltitude_m ) const

inline

CalcDynamicPressure_psf()

double wsf::six_dof::Environment::CalcDynamicPressure_psf ( double aAltitude_m, double aSpeed_fps ) const

inline

Referenced by wsf::six_dof::PointMassMoverTestObject::AlphaAtDesiredDrag(), wsf::six_dof::PointMassMoverTestObject::AlphaAtDesiredDrag(), wsf::six_dof::RigidBodyMoverTestObject::AlphaAtDesiredDrag(), wsf::six_dof::RigidBodyMoverTestObject::AlphaAtDesiredDrag(), wsf::six_dof::PointMassMoverTestObject::CalcLevelFlightDragAndAlpha(), wsf::six_dof::RigidBodyMoverTestObject::CalcLevelFlightDragAndAlpha(), GetAeroParameters(), wsf::six_dof::RigidBodyMoverTestObject::GetPitchingMoment(), wsf::six_dof::PointMassMoverTestObject::MaxInstantaneousGLoad(), wsf::six_dof::RigidBodyMoverTestObject::MaxInstantaneousGLoad(), wsf::six_dof::PointMassMoverTestObject::TurnRateAt(), wsf::six_dof::RigidBodyMoverTestObject::TurnRateAt(), wsf::six_dof::PointMassMoverTestObject::TurnRateWithConditions(), wsf::six_dof::RigidBodyMoverTestObject::TurnRateWithConditions(), and wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcFpsFromDynamicPressure()

double wsf::six_dof::Environment::CalcFpsFromDynamicPressure ( double aAltitude_m, double aPressure_psf ) const

inline

Referenced by wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcFpsFromKcas()

double wsf::six_dof::Environment::CalcFpsFromKcas ( double aAltitude_m, double aSpeed_kcas ) const

inline

Referenced by wsf::six_dof::PilotObject::SetPositionToPlannedWaypoint(), wsf::six_dof::PilotObject::SetPositionToTempWaypoint(), and wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcFpsFromMach()

double wsf::six_dof::Environment::CalcFpsFromMach ( double aAltitude_m, double aSpeed_mach ) const

inline

Referenced by wsf::six_dof::PointMassMoverTestObject::AlphaAtDesiredDrag(), wsf::six_dof::RigidBodyMoverTestObject::AlphaAtDesiredDrag(), wsf::six_dof::PointMassMoverTestObject::CalcLevelFlightDragAndAlpha(), wsf::six_dof::RigidBodyMoverTestObject::CalcLevelFlightDragAndAlpha(), wsf::six_dof::Mover::CommandSlice(), wsf::six_dof::MoverTestObject::FuelBurnAtRequiredThrust(), wsf::six_dof::MoverTestObject::FuelBurnAtThrottleSetting(), wsf::six_dof::RigidBodyMoverTestObject::GetPitchingMoment(), wsf::six_dof::PointMassMoverTestObject::MaxInstantaneousGLoad(), wsf::six_dof::RigidBodyMoverTestObject::MaxInstantaneousGLoad(), wsf::six_dof::PilotObject::SetPositionToPlannedWaypoint(), wsf::six_dof::PilotObject::SetPositionToTempWaypoint(), wsf::six_dof::MoverTestObject::ThrottleSettingToProduceThrust(), wsf::six_dof::MoverTestObject::ThrustAtThrottleSetting(), and wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcKcasFromFps()

double wsf::six_dof::Environment::CalcKcasFromFps ( double aAltitude_m, double aSpeed_fps ) const

inline

Referenced by wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcKcasFromKtas()

double wsf::six_dof::Environment::CalcKcasFromKtas ( double aAltitude_m, double aSpeed_ktas ) const

inline

Referenced by wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcKcasFromMach()

double wsf::six_dof::Environment::CalcKcasFromMach ( double aAltitude_m, double aSpeed_mach ) const

inline

Referenced by wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcKtasFromKcas()

double wsf::six_dof::Environment::CalcKtasFromKcas ( double aAltitude_m, double aSpeed_kcas ) const

inline

Referenced by wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcKtasFromMach()

double wsf::six_dof::Environment::CalcKtasFromMach ( double aAltitude_m, double aSpeed_mach ) const

inline

Referenced by wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcMachFromFps()

double wsf::six_dof::Environment::CalcMachFromFps ( double aAltitude_m, double aSpeed_fps ) const

inline

Referenced by wsf::six_dof::PointMassMoverTestObject::AlphaAtDesiredDrag(), wsf::six_dof::RigidBodyMoverTestObject::AlphaAtDesiredDrag(), wsf::six_dof::PointMassMoverTestObject::TurnRateAt(), wsf::six_dof::RigidBodyMoverTestObject::TurnRateAt(), wsf::six_dof::PointMassMoverTestObject::TurnRateWithConditions(), wsf::six_dof::RigidBodyMoverTestObject::TurnRateWithConditions(), wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD(), and wsf::six_dof::Mover::WriteKinematicStatus().

CalcMachFromKcas()

double wsf::six_dof::Environment::CalcMachFromKcas ( double aAltitude_m, double aSpeed_kcas ) const

inline

Referenced by wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

CalcMachFromKtas()

double wsf::six_dof::Environment::CalcMachFromKtas ( double aAltitude_m, double aSpeed_ktas ) const

inline

Referenced by wsf::six_dof::script::UT_DEFINE_SCRIPT_METHOD().

GetAeroParameters()

void wsf::six_dof::Environment::GetAeroParameters	(	double	aAltitude_ft,
		double	aSpeed_fps,
		double &	aAirDensity,
		double &	aDynamicPressure_psf,
		double &	aStaticPressure_psf ) const

References CalcAirDensity_slug_ft3(), CalcAmbientPressure_psf(), and CalcDynamicPressure_psf().

Referenced by wsf::six_dof::MoverTestObject::FuelBurnAtRequiredThrust(), wsf::six_dof::MoverTestObject::FuelBurnAtThrottleSetting(), wsf::six_dof::MoverTestObject::ThrottleSettingToProduceThrust(), and wsf::six_dof::MoverTestObject::ThrustAtThrottleSetting().

GetTerrainDataElevationAndData()

double wsf::six_dof::Environment::GetTerrainDataElevationAndData ( double aLatitude, double aLongitude, UtVec3dX & aUpVectorNED, UtVec3dX & aSpeedVectorNED_mps, double & aFrictionMultiplier ) const

inline

GetTerrainElevation()

double wsf::six_dof::Environment::GetTerrainElevation ( double aLatitude, double aLongitude ) const

inline

Referenced by wsf::six_dof::utils::Autotune().

GetWindNED_mps()

UtVec3dX wsf::six_dof::Environment::GetWindNED_mps ( double aLatitude, double aLongitude, double aAltitude_m ) const

inline

IsWithinContrailBand()

bool wsf::six_dof::Environment::IsWithinContrailBand ( double aAltitude_m ) const

inline

Referenced by wsf::six_dof::Mover::WithinContrailAltitudeBand().

ProcessInput()

bool wsf::six_dof::Environment::ProcessInput ( UtInput & aInput )

overridevirtual

Process potential input for the extension. This method examines the current input command to determine if it is one that is recognized by the extension. If it is one recognized by the extension then it processes the command and returns 'true', otherwise it returns 'false'.

Parameters

aInput

a reference to a UtInput object.

Returns

'true' if the command was one recognized by the extension or 'false' if not.

Exceptions

UtInput::ExceptionBase

(or an object derived from it) if the command was recognized but contains some sort of error.

Reimplemented from WsfScenarioExtension.

---

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

• WsfSixDOF_Environment.hpp
• WsfSixDOF_Environment.cpp