wsf::six_dof::PointMassManualPilotSimpleControls Class Reference

#include <WsfPointMassSixDOF_ManualPilotSimpleControls.hpp>

Inheritance diagram for wsf::six_dof::PointMassManualPilotSimpleControls:

Collaboration diagram for wsf::six_dof::PointMassManualPilotSimpleControls:

Public Member Functions
	PointMassManualPilotSimpleControls ()=default
	~PointMassManualPilotSimpleControls ()=default
PointMassManualPilotSimpleControls &	operator= (const PointMassManualPilotSimpleControls &other)=delete
PointMassManualPilotSimpleControls *	Clone () const
bool	ProcessInput (UtInput &aInput) override
bool	Initialize (int64_t aSimTime_nanosec) override
std::string	GetPilotType () const override
bool	UseSimpleYawDamper ()
Public Member Functions inherited from wsf::six_dof::PointMassManualPilot
	PointMassManualPilot ()=default
	~PointMassManualPilot ()=default
PointMassManualPilot &	operator= (const PointMassManualPilot &other)=delete
Public Member Functions inherited from wsf::six_dof::PointMassPilotObject
	PointMassPilotObject ()=default
	~PointMassPilotObject ()=default
PointMassPilotObject &	operator= (const PointMassPilotObject &other)=delete
void	ManageFrozenControls () override
std::string	GetPilotType () const override
double	GetStickBackControllerPosition () const override
double	GetStickRightControllerPosition () const override
double	GetRudderRightControllerPosition () const override
double	GetThrottleControllerPosition () const override
double	GetThrottleMilitaryControllerPosition () const override
double	GetThrottleAfterburnerControllerPosition () const override
double	GetSpeedBrakesControllerPosition () const override
double	GetFlapsControllerPosition () const override
virtual double	GetLandingGearControllerPosition () const override
double	GetSpoilersControllerPosition () const override
double	GetThrustReverserControllerPosition () const override
void	SetManualControlData (double aStickRightPosition, double aStickAftPosition, double aThrottleLeverPosition, double aSpdBrakeLeverPosition, double aSpoilerLeverPosition, double aFlapsLeverPosition) override
void	SetManualControlData (double aStickRightPosition, double aStickAftPosition, double aRudderRightPosition, double aThrottleLeverPosition, double aSpdBrakeLeverPosition, double aSpoilerLeverPosition, double aFlapsLeverPosition) override
void	SetManualControlData (double aStickRightPosition, double aStickAftPosition, double aRudderRightPosition, double aThrottleLeverPosition, double aSpdBrakeLeverPosition, double aSpoilerLeverPosition, double aFlapsLeverPosition, double aLandingGearLeverPosition) override
void	SetManualControlData (double aStickRightPosition, double aStickAftPosition, double aRudderRightPosition, double aThrottleLeverPosition, double aThrustReverserLeverPosition, double aThrustVectorYawRightPosition, double aThrustVectorPitchUpPosition, double aThrustVectorRollRightPosition, double aSpdBrakeLeverPosition, double aSpoilerLeverPosition, double aFlapsLeverPosition, double aLandingGearLeverPosition, double aNoseWheelSteeringRightPosition, double aWheelBrakeLeftPosition, double aWheelBrakeRightPosition, bool aNWS_Enabled) override
void	SetExternalDirectControlData (double aStickRightPosition, double aStickAftPosition, double aThrottleLeverPosition, double aSpdBrakeLeverPosition, double aSpoilerLeverPosition, double aFlapsLeverPosition) override
void	SetExternalDirectControlData (double aStickRightPosition, double aStickAftPosition, double aRudderRightPosition, double aThrottleLeverPosition, double aSpdBrakeLeverPosition, double aSpoilerLeverPosition, double aFlapsLeverPosition) override
void	SetExternalDirectControlData (double aStickRightPosition, double aStickAftPosition, double aRudderRightPosition, double aThrottleLeverPosition, double aSpdBrakeLeverPosition, double aSpoilerLeverPosition, double aFlapsLeverPosition, double aLandingGearLeverPosition) override
void	SetExternalDirectControlData (double aStickRightPosition, double aStickAftPosition, double aRudderRightPosition, double aThrottleLeverPosition, double aThrustReverserLeverPosition, double aThrustVectorYawRightPosition, double aThrustVectorPitchUpPosition, double aThrustVectorRollRightPosition, double aSpdBrakeLeverPosition, double aSpoilerLeverPosition, double aFlapsLeverPosition, double aLandingGearLeverPosition, double aNoseWheelSteeringRightPosition, double aWheelBrakeLeftPosition, double aWheelBrakeRightPosition, bool aNWS_Enabled) override
void	SetTestStickBackControllerPosition (double aStickAftPosition) override
void	SetTestStickRightControllerPosition (double aStickRightPosition) override
void	SetTestRudderRightControllerPosition (double aRudderRightPosition) override
void	SetTestSpeedBrakesControllerPosition (double aSpeedBrakesPosition) override
void	SetTestFlapsControllerPosition (double aFlapsPosition) override
void	SetTestSpoilersControllerPosition (double aSpoilersPosition) override
void	SetTestLandingGearControllerPosition (double aLandingGearPosition) override
PointMassCommonController *	GetPointMassCommonController () const
CommonController *	GetCommonController () const override
void	SetDirectStickBackInput (double aStickBackPosition) override
void	SetDirectStickRightInput (double aStickBackPosition) override
void	SetDirectRudderRightInput (double aStickBackPosition) override
void	OpenSpeedBrake () override
void	CloseSpeedBrake () override
void	SetDirectSpeedBrakesInput (double aValue) override
void	SetLandingGearControlPosition (double aPosition) override
void	SetFlapsControlPosition (double aPosition) override
void	SetSpoilersControlPosition (double aPosition) override
void	SetThrustReverserControlPosition (double aPosition) override
Public Member Functions inherited from wsf::six_dof::PilotObject
	PilotObject ()=default
PilotObject &	operator= (const PilotObject &other)=delete
void	Update (int64_t aSimTime_nanosec)
void	SetLastSimTime (int64_t aLastSimTime_nanosec)
void	InputAngleDeltas (double aYaw_rad, double aPitch_rad, double aRoll_rad)
void	EnableControlInputs (bool aEnabled)
bool	ControlsAreEnabled () const
virtual void	SetDestroyed ()
virtual bool	UsingManualControl () const
virtual void	TakeManualControl ()
virtual void	ReleaseManualControl ()
virtual void	SetControlAugmentationModeActive (bool aCASIsActive)
virtual bool	ControlAugmentationModeIsActive () const
virtual void	SetTrimManualControlData (double aNoseUpTrimDeltaT_sec, double aRollRightTrimDeltaT_sec, double aYawRightTrimDeltaT_sec)
virtual void	TakeExternalDirectControl ()
virtual void	ReleaseExternalDirectControl ()
virtual void	SetExternalDirectControlTrimManualControlData (double aNoseUpTrimDeltaT_sec, double aRollRightTrimDeltaT_sec, double aYawRightTrimDeltaT_sec)
bool	UsingTestControl () const
void	TakeTestControl ()
void	ReleaseTestControl ()
virtual void	SetTestThrottleControllerPosition (double aThrottlePosition)
virtual void	SetTestThrottleMilitaryControllerPosition (double aThrottleLeverPosition)
virtual void	SetTestThrottleAfterburnerControllerPosition (double aThrottleLeverPosition)
virtual void	SetPrePositionTAS (double aAltitude_ft, double aKTAS)
virtual void	SetPrePositionCAS (double aAltitude_ft, double aKCAS)
virtual void	SetPrePositionMach (double aAltitude_ft, double aMach)
virtual void	SetPrePositionQ (double aAltitude_ft, double aDynamicPressure_lbft2)
AutopilotAction *	GetCurrentAction () const
virtual void	GetAutopilotData (AutopilotData *aData)
virtual bool	GetAutopilotPidGainData (Pid::Type aTableType, size_t &aNumElements, PidGainData aPidGainData[])
virtual void	GetAutopilotPidValueData (AutopilotPidGroupValueData *aData)
virtual void	SetPlannedRoute (Route *aRoute)
virtual void	SetTempRoute (Route *aRoute)
virtual bool	GetAfterburnerEnabled () const
virtual void	SetAfterburnerEnabled (bool aEnabled)
virtual double	GetAfterburnerThreshold () const
virtual void	SetAfterburnerThreshold (double aValue=1.0)
virtual bool	GetSpeedBrakeEnabled () const
virtual void	SetSpeedBrakeEnabled (bool aEnabled)
virtual double	GetSpeedBrakeThreshold () const
virtual void	SetSpeedBrakeThreshold (double aValue=0.0)
double	GetTurnRollInMultiplier ()
void	SetTurnRollInMultiplier (double aValue=1.0)
CommonController::sAutopilotControls *	GetCurrentControlLimits ()
virtual void	EnableDirectThrottleInput ()
virtual void	ReleaseDirectThrottleInput ()
virtual void	MoveThrottleToIdle ()
virtual void	MoveThrottleToFull ()
virtual void	MoveThrottleToAfterburner ()
virtual void	SetDirectThrottleInput (double aValue)
virtual void	EnableDirectStickBackInput ()
virtual void	ReleaseDirectStickBackInput ()
virtual void	EnableDirectStickRightInput ()
virtual void	ReleaseDirectStickRightInput ()
virtual void	EnableDirectRudderRightInput ()
virtual void	ReleaseDirectRudderRightInput ()
virtual void	EnableDirectSpeedBrakeInput ()
virtual void	ReleaseDirectSpeedBrakeInput ()
virtual void	FlyTempWaypoints (Route *aRoute)
virtual size_t	GetPlannedWaypointIndex () const
virtual bool	SetPlannedWaypointIndex (size_t aIndex)
virtual bool	SetPositionToPlannedWaypoint (size_t aIndex)
virtual size_t	GetTempWaypointIndex () const
virtual bool	SetTempWaypointIndex (size_t aIndex)
virtual bool	SetPositionToTempWaypoint (size_t aIndex)
virtual bool	IsOnPlannedRoute () const
virtual void	FlyAtPoint (const UtLLAPos &aPt)
virtual void	ReturnToPlannedWaypoints ()
virtual void	TurnToHeading (double aHeading_rad, double aRadialAccel, CommonController::eAutopilotTurnDir aTurn)
	radial accel and turn direction ignored for now
virtual void	GoToSpeed (double aSpeed, double aLinearAccel)
virtual void	GoToAltitude (double aAltitude, double aClimbRate)
virtual bool	FlyRates (double aRollRate, double aPitchRate, double aAcceleration, double aSpeed)
virtual bool	FlyHeadingSpeedAltitude (double aHeading_rad, double aSpeed, double aAltitude, double aMaxGees, double aMaxClimb)
virtual bool	FlySpecificTurn (double aRollError, double aGees, double aSpeed)
virtual bool	FlySpecificVector (double aRollError, double aPitchError, double aMaxGees, double aSpeed)
virtual bool	FlyYawPitchAccel (double aYawAccel_g, double aPitchAccel_g)
virtual bool	AutopilotIsEnabled () const
virtual void	GetPlannedWaypoints (AutopilotWaypointDataList *aWaypointDataList) const
virtual void	GetTempWaypoints (AutopilotWaypointDataList *aWaypointDataList) const
virtual void	GetCurrentWaypoints (AutopilotWaypointDataList *aWaypointDataList) const
virtual void	EnableAutopilot (bool aState)
virtual void	SetAutopilotPitchAngle (double aPitchAngle_deg)
virtual void	SetAutopilotPitchRate (double aPitchRate_dps)
virtual void	SetAutopilotFlightPathAngle (double aFlightPathAngle_deg)
virtual void	SetAutopilotVerticalSpeed (double aVerticalSpeed_fpm)
virtual void	SetAutopilotAltitude (double aAltitude_ft)
virtual void	SetPitchGLoad (double aGLoad)
virtual void	SetAutopilotAlpha (double aAlpha_deg)
virtual void	SetAutopilotDeltaPitch (double aDeltaPitchAngle_deg)
virtual void	SetAutopilotRollAngle (double aRollAngle_deg)
virtual void	SetAutopilotRollRate (double aRollRate_dps)
virtual void	SetAutopilotDeltaRoll (double aDeltaRollAngle_deg)
virtual void	SetAutopilotRollHeading (double aRollHeading_deg)
virtual void	SetAutopilotYawHeading (double aYawHeading_deg)
virtual void	SetAutopilotYawRate (double aYawRate_dps)
virtual void	SetAutopilotBeta (double aBeta_deg)
virtual void	SetAutopilotYawGLoad (double aBeta_deg)
virtual void	SetAutopilotSpeedKTAS (double aSpeed_KTAS)
virtual void	SetAutopilotSpeedKCAS (double aSpeed_KCAS)
virtual void	SetAutopilotSpeedMach (double aSpeed_Mach)
virtual void	SetAutopilotThrottle (double aSpeed_Mach)
virtual void	SetAutopilotLateralWaypointMode ()
virtual void	SetAutopilotVerticalWaypointMode ()
virtual void	SetAutopilotSpeedWaypointMode ()
virtual void	SetAutopilotWaypointMode ()
virtual void	SetAutopilotNoControl ()
virtual void	HoldAltitude ()
virtual void	HoldVerticalSpeed ()
virtual void	HoldPitchAngle ()
virtual void	HoldBankAngle ()
virtual void	HoldHeading ()
virtual void	HoldSpeedKCAS ()
virtual void	HoldSpeedKTAS ()
virtual void	HoldSpeedMach ()
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
	PointMassManualPilotSimpleControls (PointMassPilotObject *aPilotObject)
	PointMassManualPilotSimpleControls (const PointMassManualPilotSimpleControls &aSrc)=default
Protected Member Functions inherited from wsf::six_dof::PointMassManualPilot
	PointMassManualPilot (PointMassPilotObject *aPilotObject)
	PointMassManualPilot (const PointMassManualPilot &aSrc)=default
Protected Member Functions inherited from wsf::six_dof::PointMassPilotObject
	PointMassPilotObject (const PointMassPilotObject &aSrc)
void	ZeroDisabledControlData () override
void	InheritParentControlData () override
void	SetThrottleData (double aThrottleLeverPosition) override
void	SetThrottleMilitaryData (double aThrottleLeverPosition) override
void	SetThrottleAfterburnerData (double aThrottleLeverPosition) override
void	EnforceControlLimits () override
void	LoadControlDataWithAutopilotControlData () override
void	LoadControlDataWithAutopilotStabilityData () override
Protected Member Functions inherited from wsf::six_dof::PilotObject
	PilotObject (const PilotObject &aSrc)
bool	InitializeCommonController ()
virtual void	UpdateControlInputsUsingCommonControllerData (int64_t aSimTime_nanosec)
void	EnforceSingleControlLimit (double &aValue, const double &aMinValue, const double &aMaxValue)
virtual void	SetControlDataWithAutopilotControls ()
virtual void	SetControlDataWithControlAugmentationControls ()
virtual void	SetControlDataWithStabilityAugmentationControls ()
virtual void	SetObjectState (double aLat, double aLon, double aAlt, double aNEDVelN_mps, double aNEDVelE_mps, double aNEDVelD_mps, double aLocalHeading_rad, double aLocalPitch_rad, double aLocalRoll_rad)
virtual bool	ClonePlannedActionToTempAction ()
virtual void	SetTempActionToHoldCurrentConditions ()
virtual void	CreateTempActionIfNeeded ()
virtual void	SetTempActionToPlannedDataOrCurrentConditions ()
virtual bool	ControlModeTestingActive () const
virtual bool	ControlModeDisabledActive () const
virtual bool	ControlModeAutopilotActive () const
virtual bool	ControlModeManualActive () const
virtual bool	ControlModeExternalDirectActive () const
virtual bool	ControlModeControlAugmentationActive () const
virtual bool	ControlModeStabilityAugmentationActive () const
Protected Member Functions inherited from wsf::six_dof::Object
	Object (const Object &)=default

Protected Attributes
bool	mSimpleYawDamper = false
Protected Attributes inherited from wsf::six_dof::PointMassPilotObject
UtCloneablePtr< PointMassCommonController >	mCommonController {nullptr}
float	mStdStickBack = 0.0f
float	mStdStickRight = 0.0f
float	mStdRudderRight = 0.0f
float	mStdThrottleMil = 0.0f
float	mStdThrottleAB = 0.0f
float	mStdSpeedBrakesOut = 0.0f
float	mStdFlapsDown = 0.0f
float	mStdSpoilersOut = 0.0f
Protected Attributes inherited from wsf::six_dof::PilotObject
int64_t	mLastSimTime_nanosec = 0
CommonController::sAutopilotControls	mAutopilotControls
UtCloneablePtr< AutopilotAction >	mAutopilotActionPtr {nullptr}
const Waypoint *	mPlannedPrevWptDataPtr = nullptr
const Waypoint *	mPlannedCurrWptDataPtr = nullptr
const Waypoint *	mPlannedNextWptDataPtr = nullptr
UtCloneablePtr< const Route >	mPlannedRoutePtr {nullptr}
size_t	mCurrentPlannedWaypointIndex = -1
UtCloneablePtr< AutopilotAction >	mTempActionPtr {nullptr}
const Waypoint *	mTempPrevWptDataPtr = nullptr
const Waypoint *	mTempCurrWptDataPtr = nullptr
const Waypoint *	mTempNextWptDataPtr = nullptr
UtCloneablePtr< Route >	mTempRoutePtr {nullptr}
size_t	mCurrentTempWaypointIndex = -1
Route	mTransitionRoute
double	mControlAugmentationStickBack = 0.0
double	mControlAugmentationStickRight = 0.0
double	mControlAugmentationRudderRight = 0.0
double	mPitchControlAugmentationFactor_g = 10.0
double	mYawControlAugmentationFactor_g = 10.0
double	mYawControlAugmentationFactor_deg = 30.0
double	mRollControlAugmentationFactor_dps = 180.0
double	mPitchTrimFactor = 0.1
double	mRollTrimFactor = 0.1
double	mYawTrimFactor = 0.1
double	mNoseUpTrimDeltaT_sec = 0.0
double	mRollRightTrimDeltaT_sec = 0.0
double	mYawRightTrimDeltaT_sec = 0.0
double	mTrimNoseUp = 0.0
double	mTrimRollRight = 0.0
double	mTrimYawRight = 0.0
UtCloneablePtr< UtTable::Curve >	mPitchControlMapping {nullptr}
UtCloneablePtr< UtTable::Curve >	mRollControlMapping {nullptr}
UtCloneablePtr< UtTable::Curve >	mYawControlMapping {nullptr}
bool	mControlOverrideStickBack = false
bool	mControlOverrideStickRight = false
bool	mControlOverrideRudderRight = false
bool	mControlOverrideThrottle = false
bool	mControlOverrideSpeedBrakes = false
bool	mControlAugmentationModeActive = false
bool	mPitchStabilityAugmentationModeActive = false
bool	mRollStabilityAugmentationModeActive = false
bool	mYawStabilityAugmentationModeActive = false
bool	mParentControl = false
bool	mManualControl = false
bool	mExternalDirectControl = false
bool	mAutopilotEnabled = true
bool	mControlsEnabled = true
bool	mTestControl = false
bool	mIsDestroyed = false
Protected Attributes inherited from wsf::six_dof::Object
std::string	mObjName = ""
Mover *	mParentVehicle = nullptr

Friends
class	PointMassPilotManager

Additional Inherited Members
Public Attributes inherited from wsf::six_dof::PilotObject
UtCallbackListN< bool(unsigned int)>	WaypointAchieved

Constructor & Destructor Documentation

PointMassManualPilotSimpleControls() [1/3]

wsf::six_dof::PointMassManualPilotSimpleControls::PointMassManualPilotSimpleControls ( )

default

Referenced by Clone(), operator=(), and PointMassManualPilotSimpleControls().

~PointMassManualPilotSimpleControls()

wsf::six_dof::PointMassManualPilotSimpleControls::~PointMassManualPilotSimpleControls ( )

default

PointMassManualPilotSimpleControls() [2/3]

wsf::six_dof::PointMassManualPilotSimpleControls::PointMassManualPilotSimpleControls ( PointMassPilotObject * aPilotObject )

explicitprotected

References wsf::six_dof::PointMassManualPilot::PointMassManualPilot().

PointMassManualPilotSimpleControls() [3/3]

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

protecteddefault

References PointMassManualPilotSimpleControls().

Member Function Documentation

Clone()

wsf::six_dof::PointMassManualPilotSimpleControls * wsf::six_dof::PointMassManualPilotSimpleControls::Clone

(

)

const

References PointMassManualPilotSimpleControls().

Referenced by operator=().

GetPilotType()

std::string wsf::six_dof::PointMassManualPilotSimpleControls::GetPilotType ( ) const

inlineoverridevirtual

Reimplemented from wsf::six_dof::PointMassManualPilot.

Initialize()

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

overridevirtual

Reimplemented from wsf::six_dof::PointMassPilotObject.

References wsf::six_dof::PointMassPilotObject::Initialize().

Referenced by operator=().

operator=()

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

delete

References Clone(), Initialize(), PointMassManualPilotSimpleControls(), and ProcessInput().

ProcessInput()

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

overridevirtual

Reimplemented from wsf::six_dof::PointMassPilotObject.

References wsf::six_dof::PilotObject::mPitchControlMapping, wsf::six_dof::PilotObject::mPitchTrimFactor, wsf::six_dof::PilotObject::mRollControlMapping, wsf::six_dof::PilotObject::mRollTrimFactor, mSimpleYawDamper, wsf::six_dof::PilotObject::mYawControlMapping, wsf::six_dof::PilotObject::mYawTrimFactor, and wsf::six_dof::PointMassPilotObject::ProcessInput().

Referenced by operator=().

UseSimpleYawDamper()

bool wsf::six_dof::PointMassManualPilotSimpleControls::UseSimpleYawDamper ( )

inline

References mSimpleYawDamper.

Friends And Related Symbol Documentation

PointMassPilotManager

friend class PointMassPilotManager

friend

References PointMassPilotManager.

Referenced by PointMassPilotManager.

Member Data Documentation

mSimpleYawDamper

bool wsf::six_dof::PointMassManualPilotSimpleControls::mSimpleYawDamper = false

protected

Referenced by ProcessInput(), and UseSimpleYawDamper().

---

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

• WsfPointMassSixDOF_ManualPilotSimpleControls.hpp
• WsfPointMassSixDOF_ManualPilotSimpleControls.cpp