#include <WsfSixDOF_ThrustProducerObject.hpp>

Inheritance diagram for wsf::six_dof::ThrustProducerObject:

[legend]

Collaboration diagram for wsf::six_dof::ThrustProducerObject:

[legend]

Public Member Functions
	ThrustProducerObject ()=default
	~ThrustProducerObject ()=default
ThrustProducerObject &	operator= (const ThrustProducerObject &other)=delete
virtual ThrustProducerObject *	Clone () const =0
void	SetParentPropulsionSystem (PropulsionSystem *aParent)
PropulsionSystem *	GetParentPropulsionSystem ()
void	SetEngine (std::unique_ptr< Engine > aEngine)
const Engine *	GetEngine () const
virtual bool	ProcessInput (UtInput &aInput, TypeManager *aTypeManager)
bool	Initialize (int64_t aSimTime_nanosec)
std::string	GetBaseName ()
void	Ignite (int64_t aIgniteTimeInFrame_nanosec)
void	Shutdown (int64_t aTerminateTime_nanosec=0)
virtual void	SetThrustReferenceOffsetAttitude (const UtVec3dX &aReferenceLocation_ft, const UtVec3dX &aThrustYPR_rad)=0
double	GetMaximumPotentialThrust_lbs (double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad)
double	GetMinimumPotentialThrust_lbs (double aAlt_ft, double aDynPress_lbsqft, double aStatPress_lbssqft, double aSpeed_fps, double aMach, double aAlpha_rad, double aBeta_rad)
double	GetInoperatingDragArea_ft2 ()
virtual double	GetThrottleMilSetting ()=0
virtual double	GetThrottleAbSetting ()=0
void	GetThrustLocation (UtVec3dX &aThrustLocation_ft) const
void	GetReferenceLocation (UtVec3dX &aReferenceLocation_ft) const
void	GetThrustInstalledAnglesYPR (UtVec3dX &aThrustYPR_rad) const
double	GetThrottlePosition () const
void	SetThrottlePosition (double aThrottleLeverPosition)
void	SetThrustVectoringEnabled (bool aThrustVectoringEnabled)
bool	ThrustVectoringEnabled () const
double	GetFuelBurnRate_pph () const
double	GetThrust_lbs () const
double	GetForwardThrust_lbs () const
virtual void	GetCurrentThrustVectorDirection (UtVec3dX &aDirection) const =0
virtual bool	SetFuelTank (const std::string &aFuelTankName)
bool	EngineOperating () const
bool	MayHaveEngineOperating () const
bool	MayProduceEngineSmoke () const
bool	MayContrail () const
bool	ProducingSmokeTrail () const
bool	MayProduceSmokeTrail () const
bool	AfterburnerOn () const
bool	Contrailing () const
bool	EngineSmoking () const
void	MakeEngineSmoke (bool aSmoking)
virtual bool	AfterburnerIsPresent () const
Public Member Functions inherited from wsf::six_dof::Object
	Object ()=default
virtual	~Object ()=default
virtual std::string	GetName () const
virtual void	SetName (const std::string &aName)
virtual Mover *	GetParentVehicle () const
virtual void	SetParentVehicle (Mover *aParentVehicle)

Protected Member Functions
	ThrustProducerObject (const ThrustProducerObject &aSrc)
virtual void	DeriveFrom (const ThrustProducerObject *aSrc)
bool	ProcessInputType (UtInput &aInput, TypeManager *aTypeManager)
Protected Member Functions inherited from wsf::six_dof::Object
	Object (const Object &)=default

Protected Attributes
std::string	mBaseName
PropulsionSystem *	mParentPropulsionSystemPtr = nullptr
UtCloneablePtr< Engine >	mEnginePtr {nullptr}
UtVec3dX	mNominalThrustVectorDirection = UtVec3dX::cUNIT_FORWARD
UtVec3dX	mThrustInstalledAnglesYPR_rad
UtVec3dX	mReferenceLocation_ft
UtVec3dX	mThrustLocation_ft
double	mThrustOffset_ft = 0.0
double	mInOpRefArea_ft2 = 1.0
bool	mThrustVectoringEnabled = false
Protected Attributes inherited from wsf::six_dof::Object
std::string	mObjName = ""
Mover *	mParentVehicle = nullptr

Constructor & Destructor Documentation

◆ ThrustProducerObject() [1/2]

wsf::six_dof::ThrustProducerObject::ThrustProducerObject ( )

default

Referenced by Clone(), wsf::six_dof::PointMassThrustProducerObject::DeriveFrom(), wsf::six_dof::RigidBodyThrustProducerObject::DeriveFrom(), DeriveFrom(), wsf::six_dof::PointMassThrustProducerObject::operator=(), wsf::six_dof::RigidBodyThrustProducerObject::operator=(), operator=(), wsf::six_dof::PointMassThrustProducerObject::PointMassThrustProducerObject(), wsf::six_dof::RigidBodyThrustProducerObject::RigidBodyThrustProducerObject(), and ThrustProducerObject().

◆ ~ThrustProducerObject()

wsf::six_dof::ThrustProducerObject::~ThrustProducerObject ( )

default

◆ ThrustProducerObject() [2/2]

wsf::six_dof::ThrustProducerObject::ThrustProducerObject ( const ThrustProducerObject & aSrc )

protected

References mEnginePtr, mInOpRefArea_ft2, mNominalThrustVectorDirection, mParentPropulsionSystemPtr, mReferenceLocation_ft, mThrustInstalledAnglesYPR_rad, mThrustLocation_ft, mThrustOffset_ft, mThrustVectoringEnabled, wsf::six_dof::Object::Object(), and ThrustProducerObject().

Member Function Documentation

◆ AfterburnerIsPresent()

virtual bool wsf::six_dof::ThrustProducerObject::AfterburnerIsPresent ( ) const

inlinevirtual

References mEnginePtr.

Referenced by wsf::six_dof::MoverTestObject::FuelBurnAtRequiredThrust(), wsf::six_dof::Mover::HasAfterburner(), and wsf::six_dof::MoverTestObject::ThrottleSettingToProduceThrust().

◆ AfterburnerOn()

bool wsf::six_dof::ThrustProducerObject::AfterburnerOn ( ) const

inline

References mEnginePtr.

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

◆ Clone()

virtual ThrustProducerObject * wsf::six_dof::ThrustProducerObject::Clone ( ) const

pure virtual

Implemented in wsf::six_dof::PointMassThrustProducerObject, and wsf::six_dof::RigidBodyThrustProducerObject.

References ThrustProducerObject().

Referenced by wsf::six_dof::PointMassPropulsionSystem::ProcessInput(), and wsf::six_dof::RigidBodyPropulsionSystem::ProcessInput().

◆ Contrailing()

bool wsf::six_dof::ThrustProducerObject::Contrailing ( ) const

inline

References mEnginePtr.

◆ DeriveFrom()

void wsf::six_dof::ThrustProducerObject::DeriveFrom ( const ThrustProducerObject * aSrc )

protectedvirtual

Reimplemented in wsf::six_dof::PointMassThrustProducerObject, and wsf::six_dof::RigidBodyThrustProducerObject.

References mEnginePtr, mInOpRefArea_ft2, mNominalThrustVectorDirection, mReferenceLocation_ft, mThrustInstalledAnglesYPR_rad, mThrustLocation_ft, mThrustOffset_ft, mThrustVectoringEnabled, and ThrustProducerObject().

Referenced by wsf::six_dof::PointMassThrustProducerObject::DeriveFrom(), wsf::six_dof::RigidBodyThrustProducerObject::DeriveFrom(), and ProcessInputType().

◆ EngineOperating()

bool wsf::six_dof::ThrustProducerObject::EngineOperating ( ) const

inline

References mEnginePtr.

◆ EngineSmoking()

bool wsf::six_dof::ThrustProducerObject::EngineSmoking ( ) const

inline

References mEnginePtr.

◆ GetBaseName()

std::string wsf::six_dof::ThrustProducerObject::GetBaseName ( )

inline

References mBaseName.

◆ GetCurrentThrustVectorDirection()

virtual void wsf::six_dof::ThrustProducerObject::GetCurrentThrustVectorDirection ( UtVec3dX & aDirection ) const

pure virtual

Implemented in wsf::six_dof::PointMassThrustProducerObject, and wsf::six_dof::RigidBodyThrustProducerObject.

References SetFuelTank().

Referenced by GetForwardThrust_lbs().

◆ GetEngine()

const Engine * wsf::six_dof::ThrustProducerObject::GetEngine ( ) const

inline

References mEnginePtr.

Referenced by wsf::six_dof::Mover::GetNormalizedAfterburnerThrust(), wsf::six_dof::Mover::GetNormalizedMilitaryThrust(), and wsf::six_dof::MoverTestObject::GetTestEngineFromThrustProducer().

◆ GetForwardThrust_lbs()

double wsf::six_dof::ThrustProducerObject::GetForwardThrust_lbs ( ) const

References GetCurrentThrustVectorDirection(), and GetThrust_lbs().

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

◆ GetFuelBurnRate_pph()

double wsf::six_dof::ThrustProducerObject::GetFuelBurnRate_pph ( ) const

inline

References mEnginePtr.

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

◆ GetInoperatingDragArea_ft2()

double wsf::six_dof::ThrustProducerObject::GetInoperatingDragArea_ft2 ( )

References mInOpRefArea_ft2.

Referenced by SetThrustReferenceOffsetAttitude().

◆ GetMaximumPotentialThrust_lbs()

double wsf::six_dof::ThrustProducerObject::GetMaximumPotentialThrust_lbs	(	double	aAlt_ft,
		double	aDynPress_lbsqft,
		double	aStatPress_lbssqft,
		double	aSpeed_fps,
		double	aMach,
		double	aAlpha_rad,
		double	aBeta_rad )

References mEnginePtr.

Referenced by SetThrustReferenceOffsetAttitude().

◆ GetMinimumPotentialThrust_lbs()

double wsf::six_dof::ThrustProducerObject::GetMinimumPotentialThrust_lbs	(	double	aAlt_ft,
		double	aDynPress_lbsqft,
		double	aStatPress_lbssqft,
		double	aSpeed_fps,
		double	aMach,
		double	aAlpha_rad,
		double	aBeta_rad )

References mEnginePtr.

Referenced by SetThrustReferenceOffsetAttitude().

◆ GetParentPropulsionSystem()

PropulsionSystem * wsf::six_dof::ThrustProducerObject::GetParentPropulsionSystem ( )

inline

References mParentPropulsionSystemPtr.

◆ GetReferenceLocation()

void wsf::six_dof::ThrustProducerObject::GetReferenceLocation ( UtVec3dX & aReferenceLocation_ft ) const

inline

References mReferenceLocation_ft.

◆ GetThrottleAbSetting()

virtual double wsf::six_dof::ThrustProducerObject::GetThrottleAbSetting ( )

pure virtual

Implemented in wsf::six_dof::PointMassThrustProducerObject, and wsf::six_dof::RigidBodyThrustProducerObject.

◆ GetThrottleMilSetting()

virtual double wsf::six_dof::ThrustProducerObject::GetThrottleMilSetting ( )

pure virtual

Implemented in wsf::six_dof::PointMassThrustProducerObject, and wsf::six_dof::RigidBodyThrustProducerObject.

◆ GetThrottlePosition()

double wsf::six_dof::ThrustProducerObject::GetThrottlePosition ( ) const

inline

References mEnginePtr.

◆ GetThrust_lbs()

double wsf::six_dof::ThrustProducerObject::GetThrust_lbs ( ) const

inline

References mEnginePtr.

Referenced by GetForwardThrust_lbs().

◆ GetThrustInstalledAnglesYPR()

void wsf::six_dof::ThrustProducerObject::GetThrustInstalledAnglesYPR ( UtVec3dX & aThrustYPR_rad ) const

inline

References mThrustInstalledAnglesYPR_rad.

◆ GetThrustLocation()

void wsf::six_dof::ThrustProducerObject::GetThrustLocation ( UtVec3dX & aThrustLocation_ft ) const

inline

References mThrustLocation_ft.

◆ Ignite()

void wsf::six_dof::ThrustProducerObject::Ignite ( int64_t aIgniteTimeInFrame_nanosec )

inline

References mEnginePtr.

Referenced by wsf::six_dof::Sequencer::TestForActivation().

◆ Initialize()

bool wsf::six_dof::ThrustProducerObject::Initialize ( int64_t aSimTime_nanosec )

inline

References mEnginePtr.

◆ MakeEngineSmoke()

void wsf::six_dof::ThrustProducerObject::MakeEngineSmoke ( bool aSmoking )

inline

References mEnginePtr.

Referenced by wsf::six_dof::PointMassPropulsionSystem::MakeAnEngineSmoke(), and wsf::six_dof::RigidBodyPropulsionSystem::MakeAnEngineSmoke().

◆ MayContrail()

bool wsf::six_dof::ThrustProducerObject::MayContrail ( ) const

inline

References mEnginePtr.

◆ MayHaveEngineOperating()

bool wsf::six_dof::ThrustProducerObject::MayHaveEngineOperating ( ) const

inline

References mEnginePtr.

◆ MayProduceEngineSmoke()

bool wsf::six_dof::ThrustProducerObject::MayProduceEngineSmoke ( ) const

inline

References mEnginePtr.

◆ MayProduceSmokeTrail()

bool wsf::six_dof::ThrustProducerObject::MayProduceSmokeTrail ( ) const

inline

References mEnginePtr.

◆ operator=()

ThrustProducerObject & wsf::six_dof::ThrustProducerObject::operator= ( const ThrustProducerObject & other )

delete

References ThrustProducerObject().

◆ ProcessInput()

bool wsf::six_dof::ThrustProducerObject::ProcessInput	(	UtInput &	aInput,
		TypeManager *	aTypeManager )

virtual

Reimplemented in wsf::six_dof::PointMassThrustProducerObject, and wsf::six_dof::RigidBodyThrustProducerObject.

References mInOpRefArea_ft2, mThrustOffset_ft, and SetEngine().

Referenced by wsf::six_dof::PointMassThrustProducerObject::ProcessInput(), and wsf::six_dof::RigidBodyThrustProducerObject::ProcessInput().

◆ ProcessInputType()

bool wsf::six_dof::ThrustProducerObject::ProcessInputType	(	UtInput &	aInput,
		TypeManager *	aTypeManager )

protected

References DeriveFrom(), wsf::six_dof::TypeManager::GetThrustProducerObjectType(), mBaseName, wsf::six_dof::Object::mObjName, and wsf::six_dof::TypeManager::ThrustProducerObjectTypeExists().

Referenced by wsf::six_dof::PointMassThrustProducerObject::ProcessInput(), and wsf::six_dof::RigidBodyThrustProducerObject::ProcessInput().

◆ ProducingSmokeTrail()

bool wsf::six_dof::ThrustProducerObject::ProducingSmokeTrail ( ) const

inline

References mEnginePtr.

◆ SetEngine()

void wsf::six_dof::ThrustProducerObject::SetEngine ( std::unique_ptr< Engine > aEngine )

inline

References mEnginePtr.

Referenced by ProcessInput().

◆ SetFuelTank()

bool wsf::six_dof::ThrustProducerObject::SetFuelTank ( const std::string & aFuelTankName )

virtual

References mEnginePtr.

Referenced by GetCurrentThrustVectorDirection().

◆ SetParentPropulsionSystem()

void wsf::six_dof::ThrustProducerObject::SetParentPropulsionSystem ( PropulsionSystem * aParent )

inline

References mParentPropulsionSystemPtr.

◆ SetThrottlePosition()

void wsf::six_dof::ThrustProducerObject::SetThrottlePosition ( double aThrottleLeverPosition )

inline

References mEnginePtr.

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

◆ SetThrustReferenceOffsetAttitude()

virtual void wsf::six_dof::ThrustProducerObject::SetThrustReferenceOffsetAttitude	(	const UtVec3dX &	aReferenceLocation_ft,
		const UtVec3dX &	aThrustYPR_rad )

pure virtual

Implemented in wsf::six_dof::PointMassThrustProducerObject, and wsf::six_dof::RigidBodyThrustProducerObject.

References GetInoperatingDragArea_ft2(), GetMaximumPotentialThrust_lbs(), and GetMinimumPotentialThrust_lbs().

◆ SetThrustVectoringEnabled()

void wsf::six_dof::ThrustProducerObject::SetThrustVectoringEnabled ( bool aThrustVectoringEnabled )

inline

References mThrustVectoringEnabled.

◆ Shutdown()

void wsf::six_dof::ThrustProducerObject::Shutdown ( int64_t aTerminateTime_nanosec = 0 )

inline

References mEnginePtr.

Referenced by wsf::six_dof::Sequencer::TestForActivation().

◆ ThrustVectoringEnabled()

bool wsf::six_dof::ThrustProducerObject::ThrustVectoringEnabled ( ) const

inline

References mThrustVectoringEnabled.

Member Data Documentation

◆ mBaseName

std::string wsf::six_dof::ThrustProducerObject::mBaseName

protected

Referenced by wsf::six_dof::PointMassThrustProducerObject::DeriveFrom(), wsf::six_dof::RigidBodyThrustProducerObject::DeriveFrom(), GetBaseName(), and ProcessInputType().

◆ mEnginePtr

UtCloneablePtr<Engine> wsf::six_dof::ThrustProducerObject::mEnginePtr {nullptr}

protected

Referenced by AfterburnerIsPresent(), AfterburnerOn(), wsf::six_dof::PointMassThrustProducerObject::CalculateThrust(), wsf::six_dof::RigidBodyThrustProducerObject::CalculateThrust(), Contrailing(), DeriveFrom(), EngineOperating(), EngineSmoking(), GetEngine(), GetFuelBurnRate_pph(), GetMaximumPotentialThrust_lbs(), GetMinimumPotentialThrust_lbs(), GetThrottlePosition(), GetThrust_lbs(), Ignite(), Initialize(), MakeEngineSmoke(), MayContrail(), MayHaveEngineOperating(), MayProduceEngineSmoke(), MayProduceSmokeTrail(), wsf::six_dof::PointMassThrustProducerObject::ProcessInput(), wsf::six_dof::RigidBodyThrustProducerObject::ProcessInput(), ProducingSmokeTrail(), SetEngine(), SetFuelTank(), SetThrottlePosition(), Shutdown(), ThrustProducerObject(), wsf::six_dof::PointMassThrustProducerObject::UpdateThrust(), and wsf::six_dof::RigidBodyThrustProducerObject::UpdateThrust().

◆ mInOpRefArea_ft2

double wsf::six_dof::ThrustProducerObject::mInOpRefArea_ft2 = 1.0

protected

Referenced by DeriveFrom(), GetInoperatingDragArea_ft2(), ProcessInput(), and ThrustProducerObject().

◆ mNominalThrustVectorDirection

UtVec3dX wsf::six_dof::ThrustProducerObject::mNominalThrustVectorDirection = UtVec3dX::cUNIT_FORWARD

protected

Referenced by wsf::six_dof::RigidBodyThrustProducerObject::CalcCurrentThrustVectors(), wsf::six_dof::PointMassThrustProducerObject::CalcThrustVectorFromThrust(), DeriveFrom(), wsf::six_dof::PointMassThrustProducerObject::GetCurrentThrustVectorDirection(), wsf::six_dof::PointMassThrustProducerObject::SetThrustReferenceOffsetAttitude(), wsf::six_dof::RigidBodyThrustProducerObject::SetThrustReferenceOffsetAttitude(), and ThrustProducerObject().

◆ mParentPropulsionSystemPtr

PropulsionSystem* wsf::six_dof::ThrustProducerObject::mParentPropulsionSystemPtr = nullptr

protected

Referenced by GetParentPropulsionSystem(), SetParentPropulsionSystem(), and ThrustProducerObject().

◆ mReferenceLocation_ft

UtVec3dX wsf::six_dof::ThrustProducerObject::mReferenceLocation_ft

protected

Referenced by DeriveFrom(), GetReferenceLocation(), wsf::six_dof::PointMassThrustProducerObject::SetThrustReferenceOffsetAttitude(), wsf::six_dof::RigidBodyThrustProducerObject::SetThrustReferenceOffsetAttitude(), and ThrustProducerObject().

◆ mThrustInstalledAnglesYPR_rad

UtVec3dX wsf::six_dof::ThrustProducerObject::mThrustInstalledAnglesYPR_rad

protected

Referenced by wsf::six_dof::RigidBodyThrustProducerObject::CalcCurrentThrustVectors(), DeriveFrom(), GetThrustInstalledAnglesYPR(), wsf::six_dof::PointMassThrustProducerObject::SetThrustReferenceOffsetAttitude(), wsf::six_dof::RigidBodyThrustProducerObject::SetThrustReferenceOffsetAttitude(), and ThrustProducerObject().

◆ mThrustLocation_ft

UtVec3dX wsf::six_dof::ThrustProducerObject::mThrustLocation_ft

protected

Referenced by wsf::six_dof::RigidBodyThrustProducerObject::CalcThrustProducerFM(), DeriveFrom(), GetThrustLocation(), wsf::six_dof::PointMassThrustProducerObject::SetThrustReferenceOffsetAttitude(), wsf::six_dof::RigidBodyThrustProducerObject::SetThrustReferenceOffsetAttitude(), and ThrustProducerObject().

◆ mThrustOffset_ft

double wsf::six_dof::ThrustProducerObject::mThrustOffset_ft = 0.0

protected

Referenced by DeriveFrom(), ProcessInput(), wsf::six_dof::PointMassThrustProducerObject::SetThrustReferenceOffsetAttitude(), wsf::six_dof::RigidBodyThrustProducerObject::SetThrustReferenceOffsetAttitude(), and ThrustProducerObject().

◆ mThrustVectoringEnabled

bool wsf::six_dof::ThrustProducerObject::mThrustVectoringEnabled = false

protected

Referenced by wsf::six_dof::RigidBodyThrustProducerObject::CalcCurrentThrustVectors(), DeriveFrom(), wsf::six_dof::RigidBodyThrustProducerObject::ProcessInput(), SetThrustVectoringEnabled(), ThrustProducerObject(), and ThrustVectoringEnabled().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ ThrustProducerObject() [1/2]

◆ ~ThrustProducerObject()

◆ ThrustProducerObject() [2/2]

Member Function Documentation

◆ AfterburnerIsPresent()

◆ AfterburnerOn()

◆ Clone()

◆ Contrailing()

◆ DeriveFrom()

◆ EngineOperating()

◆ EngineSmoking()

◆ GetBaseName()

◆ GetCurrentThrustVectorDirection()

◆ GetEngine()

◆ GetForwardThrust_lbs()

◆ GetFuelBurnRate_pph()

◆ GetInoperatingDragArea_ft2()

◆ GetMaximumPotentialThrust_lbs()

◆ GetMinimumPotentialThrust_lbs()

◆ GetParentPropulsionSystem()

◆ GetReferenceLocation()

◆ GetThrottleAbSetting()

◆ GetThrottleMilSetting()

◆ GetThrottlePosition()

◆ GetThrust_lbs()

◆ GetThrustInstalledAnglesYPR()

◆ GetThrustLocation()

◆ Ignite()

◆ Initialize()

◆ MakeEngineSmoke()

◆ MayContrail()

◆ MayHaveEngineOperating()

◆ MayProduceEngineSmoke()

◆ MayProduceSmokeTrail()

◆ operator=()

◆ ProcessInput()

◆ ProcessInputType()

◆ ProducingSmokeTrail()

◆ SetEngine()

◆ SetFuelTank()

◆ SetParentPropulsionSystem()

◆ SetThrottlePosition()

◆ SetThrustReferenceOffsetAttitude()

◆ SetThrustVectoringEnabled()

◆ Shutdown()

◆ ThrustVectoringEnabled()

Member Data Documentation

◆ mBaseName

◆ mEnginePtr

◆ mInOpRefArea_ft2

◆ mNominalThrustVectorDirection

◆ mParentPropulsionSystemPtr

◆ mReferenceLocation_ft

◆ mThrustInstalledAnglesYPR_rad

◆ mThrustLocation_ft

◆ mThrustOffset_ft

◆ mThrustVectoringEnabled