Base class for route movers that use iterative computation. More...

#include <WsfIterativeRouteMover.hpp>

Inheritance diagram for WsfIterativeRouteMover:

[legend]

Collaboration diagram for WsfIterativeRouteMover:

[legend]

Public Member Functions
	WsfIterativeRouteMover ()=delete
	WsfIterativeRouteMover (WsfScenario &aScenario)
	WsfIterativeRouteMover (const WsfIterativeRouteMover &aSrc)
WsfIterativeRouteMover &	operator= (const WsfIterativeRouteMover &)=delete
	~WsfIterativeRouteMover () override
bool	Initialize (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	Pause (double aSimTime, double aUnpauseTime) override
	Sets the mover to a paused state.
void	SetGuidanceFrom (const WsfWaypoint &aPreviousWaypoint) override
void	SetGuidanceTo (const WsfWaypoint &aPreviousWaypoint) override
void	AdvanceToNextWaypoint (double aSimTime, const WsfWaypoint &aTarget, const WsfWaypoint *aNextPointPtr) override
void	UpdatePosition (double aSimTime) override
double	GetTurnLeadDistance (double aCurrentSpeed, double aCurrentHeading)
bool	GetConverging () const
bool	GoToAltitude (double aSimTime, double aAltitude, double aClimbDiveRate, bool aKeepRoute) override
bool	GoToLocation (double aSimTime, double aLatitude, double aLongitude, double aAltitude) override
bool	GoToSpeed (double aSimTime, double aSpeed, double aLinearAccel, bool aKeepRoute) override
bool	TurnToHeading (double aSimTime, double aHeading, double aRadialAccel, WsfPath::TurnDirection aTurnDirection) override
bool	TurnToRelativeHeading (double aSimTime, double aHeadingChange, double aRadialAccel, WsfPath::TurnDirection aTurnDirection) override
WsfPathGuidance *	GetGuidance () const
Public Member Functions inherited from WsfRouteMover
	WsfRouteMover ()=delete
	WsfRouteMover (const WsfScenario &aScenario)
	WsfRouteMover (const WsfRouteMover &aSrc)
WsfRouteMover &	operator= (const WsfRouteMover &)=delete
	~WsfRouteMover () override
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
void	Update (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	TurnOff (double aSimTime) override
void	TurnOn (double aSimTime) override
const WsfRoute *	GetRoute () const override
const WsfRoute *	GetDefaultRoute () const override
int	RoutePointIndex () const override
bool	SetRoute (double aSimTime, const WsfRoute &aRoute) override
bool	GoToLabel (double aSimTime, WsfStringId aLabelId) override
bool	GoToWaypoint (double aSimTime, unsigned int aDestination) override
bool	GoToClosestPoint (double aSimTime) override
bool	FindAndSetPath (double aSimTime, WsfGeoPoint aStartPtr, WsfGeoPoint aEndPtr) override
bool	GoToLocation (double aSimTime, double aLatitude, double aLongitude, double aAltitude) override
virtual bool	Unpause (double aSimTime, bool aInterrupt)
bool	UpdateRoute (double aSimTime, const WsfRoute &aRoute) override
bool	UpdateDefaultRoute () override
virtual bool	SetRoutePoint (double aSimTime, const WsfRoute &aRoute, int aTargetPoint)
bool	ReturnToRoute (double aSimTime) override
bool	IsPaused () const override
	Returns true if the mover is paused.
WsfRouteComputer *	GetRouteComputer () const
void	SetRouteComputer (WsfRouteComputer *aRouteComputerPtr)
void	SetEndOfPath (WsfPath::EndPath aEndOfPathOption)
	Sets the default end-of-path option for the mover.
int	GetTargetIndex () const
	Return next waypoint index.
void	SetTargetIndex (int aIndex)
int	GetCurrentIndex () const
	Return current waypoint index.
bool	GoToSpeed (double aSimTime, double aSpeed, double aLinearAccel, bool aKeepRoute) override
MissTurnOption	GetTurnFailOption () const
double	GetTurnFailThreshold () const
WsfPath::Switch	GetSwitch () const
virtual const WsfPathConstraints *	GetMoverConstraints () const
Public Member Functions inherited from WsfMover
	WsfMover ()=delete
	WsfMover (const WsfScenario &aScenario)
	WsfMover (const WsfMover &aSrc)
WsfMover &	operator= (const WsfMover &)=delete
	~WsfMover () override
virtual double	TurnRadius (double atSpeed)
WsfModeList *	GetModeList () const
virtual void	TriggerExtrapolation ()
virtual KinematicModel *	CreateKinematicModel (double aSimTime, WsfStringId aPlatformTypeId, const double aLocationWCS[3], const double aVelocityWCS[3], WsfMover aMoverPtr, WsfDraw aDrawPtr) const
WsfComponent *	CloneComponent () const override
int	GetComponentInitializationOrder () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
WsfMover *	Clone () const override=0
const char *	GetScriptClassName () const override
virtual void	SwapMoverInitiated (double aSimTime, WsfMover *aOldMoverPtr)
void	SetNonOperational (double aSimTime) override
void	SetOperational (double aSimTime) override
void	PartBroken (double aSimTime) override
void	Restore (double aSimTime) override
virtual WsfSpatialDomain	GetSpatialDomain () const
virtual bool	IsStopped () const
	Return whether the mover (and its attached platform) is stopped.
virtual bool	IsExtrapolating () const
virtual void	SetHeading (double aHeading)
virtual void	SetPitch (double aPitch)
virtual void	SetRoll (double aRoll)
virtual void	SetOrientationNED (double aHeading, double aPitch, double aRoll)
virtual void	ResetPosition (double aSimTime)
	Informs the mover to use the current platform state.
double	GetLastUpdateTime () const
double	GetUpdateInterval () const override
double	GetUpdateTimeTolerance () const
void	SetUpdateInterval (double aUpdateInterval) override
void	SetLastUpdateTime (double aLastUpdateTime)
virtual bool	UpdateAllowed () const
bool	UpdateWhenBroken () const
void	SetUpdateWhenBroken ()
void	SetNoUpdateWhenBroken ()
virtual bool	FlyRates (const UtVec3d &aAngularRates, const UtVec3d &aLongitudinalAccel)
virtual bool	FlyHeadingSpeedAltitude (double aHeading, double aSpeed, double aAltitude, double aMaxGees, double aMaxClimb)
virtual bool	TurnInPlaneWithSpeed (const UtVec3d &aPlane, double aGees, double aSpeed)
virtual bool	TurnInPlaneWithThrottle (const UtVec3d &aPlane, double aGees, double aThrottle)
virtual bool	FlyVectorWithSpeed (const UtVec3d &aVelocityVector, double aMaxGees, double aSpeed)
virtual bool	FlyVectorWithThrottle (const UtVec3d &aVelocityVector, double aMaxGees, double aThrottle)
virtual bool	GetFutureLocationWCS (double aSimTime, double aLocationWCS[3])
WsfStringId	GetModeId () const
virtual void	SetMode (WsfStringId aModeName)
bool	ThreadSafe () const
	Returns true if the mover update is thread safe.
void	SetThreadSafe ()
void	SetNotThreadSafe ()
virtual void	InitializeProperties ()
	Add any input properties and its default value common properties list.
virtual bool	PropertyExists (const std::string &aPropertyName)
	Return true if the given property exists in the set of properties.
virtual void	RegisterProperty (const std::string &aPropertyName, const int &aProperty)
	Add an integer property to the common set of properties.
virtual void	RegisterProperty (const std::string &aPropertyName, const double &aProperty)
	Add an floating point property to the common set of properties.
virtual void	RegisterProperty (const std::string &aPropertyName, const std::string &aProperty)
	Add an string property to the set of common properties.
virtual bool	GetPropertyInt (const std::string &aPropertyName, int &aProperty)
virtual bool	GetPropertyDouble (const std::string &aPropertyName, double &aProperty)
virtual bool	GetPropertyString (const std::string &aPropertyName, std::string &aProperty)
virtual double	GetThrottlePosition ()
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
virtual void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatform *	GetPlatform () const
virtual void	SetPlatform (WsfPlatform *aPlatformPtr)
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void	PlatformDeleted (WsfPlatform *aPlatformPtr)
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage)
virtual bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual bool	PreInitialize (double aSimTime)
virtual void	PreInput ()
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Protected Member Functions
virtual void	LocalUpdate (double aSimTime, bool &aMoved, bool &aAdvanceToNextWaypoint)=0
virtual void	PostMoveUpdate (double aSimTime)
void	AdvanceTime (double aSimTime, bool &aAdvanceToNextWaypoint)
void	SetGuidance (WsfPathGuidance *aGuidancePtr)
void	SetConverging (bool aValue)
void	ClearConverging ()
void	ResetWPSwitching ()
double	SegmentDistRemaining () const
double	SegmentTimeRemaining () const
double	CumSegmentDist () const
double	CumSegmentTime () const
double	GetMinTurnRadius () const
	Return the current value of minimum turn radius.
bool	GetIsOnGround () const
	Return an indication of whether this platform is currently sitting on terrain.
void	SetIsOnGround (bool aValue)
bool	GetIsInAir () const
	Return an indication of whether this platform is currently in air.
void	IncrSegmentDist (double aIncrement)
void	IncrSegmentTime (double aIncrement)
void	SetMinTurnRadius (double aValue)
virtual bool	IsWaypointSwitchTime (double aSimTime)
void	SetGroundAttitude (double aLatitude, double aLongitude)
void	CalcAltitudesAndAttitude (double)
	Update the height of terrain and height above terrain values, and re-orient (if needed).
double	GetHeightOfTerrain () const
Protected Member Functions inherited from WsfRouteMover
void	TriggerUnpause (double aSimTime)
	Called when the pause time has expired to resume movement.
void	SetAltRef (WsfPath::AltRef aAltRef)
WsfPath::AltRef	GetAltRef () const
virtual void	WaypointReached (double aSimTime)
	Called when waypoint is reached.
void	RouteChanged ()
	Called when the route is changed to reset processing of current point.
bool	IsSwitchingPoints ()
void	AddUnpauseEventFor (WsfRouteMover *aMoverPtr, double aUnpauseTime)
void	DisableAndClearUnpause ()
void	SetModeList (WsfModeList *aModeListPtr)
void	SetUpdateTimeTolerance (double aDt)
	Revise the internal time tolerance allowed for Update() sequencing logic.
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)

Additional Inherited Members
Public Types inherited from WsfRouteMover
enum	MissTurnOption { cCLOSEST_POINT = 0 , cREVERSE_TURN = 1 , cSKIP_POINT = 2 }
Public Types inherited from WsfPlatformPart
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart, WsfMessage>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.
Static Public Attributes inherited from WsfMover
static const char *	cTYPE_KIND = "mover"
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
Protected Attributes inherited from WsfRouteMover
wsf::Terrain *	mTerrainPtr
bool	mForceUpdates
MissTurnOption	mTurnFailOption
	If true, the mover will ensure it passes each point.
double	mTurnFailureThreshold
	Threshold of turn failure as percentage of turn radius.
double	mUnpauseTime
	Simulation time at which the mover will unpause.
double	mAltitudeOffset
	Altitude offset of the parent platform's center of gravity / mass (CG).
double	mLastUpdateTime
	The simulation time when Update was last called.
WsfVariable< double >	mUpdateTimeTolerance
bool	mThreadSafe
std::vector< WsfMoverMode * >	mMoverModeList
	The generic list of modes (not valid until Initialize is called).
WsfStringId	mModeId

Detailed Description

Base class for route movers that use iterative computation.

Constructor & Destructor Documentation

◆ WsfIterativeRouteMover() [1/3]

WsfIterativeRouteMover::WsfIterativeRouteMover ( )

delete

References WsfIterativeRouteMover().

Referenced by operator=(), WsfIterativeRouteMover(), WsfIterativeRouteMover(), WsfRotorcraftMover::WsfRotorcraftMover(), and WsfRotorcraftMover::WsfRotorcraftMover().

◆ WsfIterativeRouteMover() [2/3]

WsfIterativeRouteMover::WsfIterativeRouteMover ( WsfScenario & aScenario )

References WsfRouteMover::WsfRouteMover().

◆ WsfIterativeRouteMover() [3/3]

WsfIterativeRouteMover::WsfIterativeRouteMover ( const WsfIterativeRouteMover & aSrc )

References WsfIterativeRouteMover(), and WsfRouteMover::WsfRouteMover().

◆ ~WsfIterativeRouteMover()

WsfIterativeRouteMover::~WsfIterativeRouteMover ( )

override

Member Function Documentation

◆ AdvanceTime()

void WsfIterativeRouteMover::AdvanceTime	(	double	aSimTime,
		bool &	aAdvanceToNextWaypoint )

protected

References WsfPlatformPart::DebugEnabled(), LocalUpdate(), WsfMover::mLastUpdateTime, and PostMoveUpdate().

Referenced by LocalUpdate(), and UpdatePosition().

◆ AdvanceToNextWaypoint()

void WsfIterativeRouteMover::AdvanceToNextWaypoint	(	double	aSimTime,
		const WsfWaypoint &	aTarget,
		const WsfWaypoint *	aNextPointPtr )

overridevirtual

Mover implementing this method should begin movement toward aTarget. WaypointReached() should be called when target waypoint is reached.

Parameters

aSimTime	The current simulation time.
aTarget	The new target waypoint
aNextPointPtr	The waypoint in the route after aTarget. May be null.

Implements WsfRouteMover.

References WsfWaypoint::cABSOLUTE_HEADING, WsfWaypoint::cDISTANCE, WsfPath::cDOUBLE_NOT_SET, WsfPath::cHDG_REF_NORTH, WsfPath::cHDG_REF_RELATIVE, WsfWaypoint::cHEADING_MASK, WsfWaypoint::cLATITUDE_AND_LONGITUDE, WsfPath::cSWITCH_ON_DISTANCE, WsfPath::cSWITCH_ON_TIME, WsfWaypoint::cTIME, WsfWaypoint::GetDistanceOrTime(), WsfWaypoint::GetHeading(), WsfWaypoint::GetLat(), WsfWaypoint::GetLon(), WsfWaypoint::GetPointType(), WsfRouteMover::GetSwitch(), WsfWaypoint::GetSwitch(), WsfWaypoint::GetTurnDirection(), and ResetWPSwitching().

◆ CalcAltitudesAndAttitude()

void WsfIterativeRouteMover::CalcAltitudesAndAttitude ( double )

protected

Update the height of terrain and height above terrain values, and re-orient (if needed).

References WsfPath::cALT_REF_MSL, WsfPlatformPart::GetPlatform(), WsfRouteMover::mTerrainPtr, and SetGroundAttitude().

Referenced by PostMoveUpdate().

◆ ClearConverging()

void WsfIterativeRouteMover::ClearConverging ( )

protected

Referenced by Initialize(), and ResetWPSwitching().

◆ CumSegmentDist()

double WsfIterativeRouteMover::CumSegmentDist ( ) const

inlineprotected

Referenced by IsWaypointSwitchTime().

◆ CumSegmentTime()

double WsfIterativeRouteMover::CumSegmentTime ( ) const

inlineprotected

Referenced by IsWaypointSwitchTime().

◆ GetConverging()

bool WsfIterativeRouteMover::GetConverging ( ) const

inline

Referenced by IsWaypointSwitchTime().

◆ GetGuidance()

WsfPathGuidance * WsfIterativeRouteMover::GetGuidance ( ) const

inline

Referenced by GetTurnLeadDistance(), IsWaypointSwitchTime(), and WsfRotorcraftMover::WsfRotorcraftMover().

◆ GetHeightOfTerrain()

double WsfIterativeRouteMover::GetHeightOfTerrain ( ) const

inlineprotected

◆ GetIsInAir()

bool WsfIterativeRouteMover::GetIsInAir ( ) const

inlineprotected

Return an indication of whether this platform is currently in air.

◆ GetIsOnGround()

bool WsfIterativeRouteMover::GetIsOnGround ( ) const

inlineprotected

Return an indication of whether this platform is currently sitting on terrain.

◆ GetMinTurnRadius()

double WsfIterativeRouteMover::GetMinTurnRadius ( ) const

inlineprotected

Return the current value of minimum turn radius.

Referenced by GetTurnLeadDistance().

◆ GetTurnLeadDistance()

double WsfIterativeRouteMover::GetTurnLeadDistance	(	double	aCurrentSpeed,
		double	aCurrentHeading )

Get the distance from the waypoint for which a 'turn_short' (cSWITCH_ON_APPROACH) should be initiated. This should only be called when the target waypoint is of type cLATITUDE_AND_LONGITUDE and specifies cSWITCH_ON_APPROACH.

References GetGuidance(), GetMinTurnRadius(), and WsfPathGuidance::GetSpeed().

Referenced by IsWaypointSwitchTime(), and operator=().

◆ GoToAltitude()

bool WsfIterativeRouteMover::GoToAltitude	(	double	aSimTime,
		double	aAltitude,
		double	aClimbDiveRate,
		bool	aKeepRoute )

overridevirtual

Command the mover change its altitude.

Parameters

aSimTime	The current simulated time (seconds).
aAltitude	The desired altitude to attempt to achieve (in meters).
aClimbDiveRate	The desired climb/dive rate (meters/second). If zero then use the mover default.
aKeepRoute	'true' if the mover should maintain current route. 'false' to extrapolate.

Returns: true if successful.

Reimplemented from WsfMover.

Reimplemented in WsfRotorcraftMover.

References WsfPlatformPart::DebugEnabled(), WsfRouteMover::GetAltRef(), WsfObject::GetName(), and WsfPlatformPart::GetPlatform().

Referenced by WsfRotorcraftMover::GoToAltitude().

◆ GoToLocation()

bool WsfIterativeRouteMover::GoToLocation	(	double	aSimTime,
		double	aLatitude,
		double	aLongitude,
		double	aAltitude )

overridevirtual

Command the mover to move towards a specified location.

Parameters

aSimTime	The current simulated clock time (seconds).
aLatitude	The desired latitude.
aLongitude	The desired longitude.
aAltitude	The desired altitude. If -1 is used for aAltitude the current altitude is used.

Returns: true if successful.

Reimplemented from WsfMover.

Reimplemented in WsfRotorcraftMover.

References WsfRoute::Append(), WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), and WsfRouteMover::UpdateRoute().

Referenced by WsfRotorcraftMover::GoToLocation().

◆ GoToSpeed()

bool WsfIterativeRouteMover::GoToSpeed	(	double	aSimTime,
		double	aSpeed,
		double	aLinearAccel,
		bool	aKeepRoute )

overridevirtual

For this Mover only, any speed request is assumed a sea level equivalent speed, and constant dynamic pressure is flown as the altitude increases or decreases.

Reimplemented from WsfMover.

Reimplemented in WsfRotorcraftMover.

References WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), and WsfPlatformPart::GetPlatform().

Referenced by WsfRotorcraftMover::GoToSpeed().

◆ IncrSegmentDist()

void WsfIterativeRouteMover::IncrSegmentDist ( double aIncrement )

inlineprotected

◆ IncrSegmentTime()

void WsfIterativeRouteMover::IncrSegmentTime ( double aIncrement )

inlineprotected

◆ Initialize()

bool WsfIterativeRouteMover::Initialize ( double aSimTime )

overridevirtual

Perform phase 1 initialization. This is called by WsfPlatform::Initialize() during phase 1 initialization of the platform. The component should complete validation of input data that could not be done by ProcessInput, as well as any other functions to prepare for simulation use (subject to the next paragraph).

The order in which components are initialized is defined by GetComponentInitializationOrder. In general a component implementation of this method should not be dependent on the state of another component, i.e.: it should not assume that the other components Initialize() method has been called. If such a dependency exists one should use Initialize2() if possible, or specify a value GetComponentInitializationOrder to force things to initialize in a particular order.

Parameters

aSimTime The current simulation time.

Returns: true if successful or false if unsuccessful (bad input data, etc.)

Note: This method should NOT add any other components to the platform. This MUST be done in PreInitialize().

Reimplemented from WsfComponent.

Reimplemented in WsfRotorcraftMover.

References ClearConverging(), WsfPlatformPart::GetPlatform(), WsfRouteMover::Initialize(), and WsfMover::mLastUpdateTime.

Referenced by WsfRotorcraftMover::Initialize().

◆ IsWaypointSwitchTime()

bool WsfIterativeRouteMover::IsWaypointSwitchTime ( double aSimTime )

protectedvirtual

Check for switching waypoints. There are several possibilities, switch if we are within one turn radius of our target point, switch after we are abreast of the target point, switch when a certain period of time has elapsed, or after a specified distance is covered.

References WsfPath::cSWITCH_EXTERNAL, WsfPath::cSWITCH_ON_APPROACH, WsfPath::cSWITCH_ON_DISTANCE, WsfPath::cSWITCH_ON_TIME, CumSegmentDist(), CumSegmentTime(), WsfComponentList::GetComponent(), GetConverging(), WsfNavigationErrors::GetGPS_Status(), GetGuidance(), WsfNavigationErrors::GetPerceivedEntity(), WsfPlatformPart::GetPlatform(), WsfPathGuidance::GetSegmentEndDist(), WsfPathGuidance::GetSegmentEndTime(), WsfPathGuidance::GetSwitch(), GetTurnLeadDistance(), and SetConverging().

Referenced by WsfRotorcraftMover::LocalUpdate().

◆ LocalUpdate()

virtual void WsfIterativeRouteMover::LocalUpdate	(	double	aSimTime,
		bool &	aMoved,
		bool &	aAdvanceToNextWaypoint )

protectedpure virtual

Implemented in WsfRotorcraftMover.

References AdvanceTime(), and PostMoveUpdate().

Referenced by AdvanceTime().

◆ operator=()

WsfIterativeRouteMover & WsfIterativeRouteMover::operator= ( const WsfIterativeRouteMover & )

delete

References GetTurnLeadDistance(), and WsfIterativeRouteMover().

◆ Pause()

void WsfIterativeRouteMover::Pause	(	double	aSimTime,
		double	aUnpauseTime )

overridevirtual

Sets the mover to a paused state.

Implements WsfRouteMover.

References WsfRouteMover::AddUnpauseEventFor(), and WsfRouteMover::mUnpauseTime.

◆ PostMoveUpdate()

void WsfIterativeRouteMover::PostMoveUpdate ( double aSimTime )

protectedvirtual

References CalcAltitudesAndAttitude().

Referenced by AdvanceTime(), and LocalUpdate().

◆ ProcessInput()

bool WsfIterativeRouteMover::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

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

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

Reimplemented in WsfRotorcraftMover.

References WsfMover::ProcessInput(), and WsfRouteMover::ProcessInput().

Referenced by WsfRotorcraftMover::ProcessInput().

◆ ResetWPSwitching()

void WsfIterativeRouteMover::ResetWPSwitching ( )

protected

References ClearConverging().

Referenced by AdvanceToNextWaypoint().

◆ SegmentDistRemaining()

double WsfIterativeRouteMover::SegmentDistRemaining ( ) const

protected

◆ SegmentTimeRemaining()

double WsfIterativeRouteMover::SegmentTimeRemaining ( ) const

protected

◆ SetConverging()

void WsfIterativeRouteMover::SetConverging ( bool aValue )

protected

Referenced by IsWaypointSwitchTime().

◆ SetGroundAttitude()

void WsfIterativeRouteMover::SetGroundAttitude	(	double	aLatitude,
		double	aLongitude )

protected

Update the orientation of the platform to conform to local ground slope. It is assumed this method will not be called unless already on ground.

References WsfPlatformPart::GetPlatform(), and WsfRouteMover::mTerrainPtr.

Referenced by CalcAltitudesAndAttitude().

◆ SetGuidance()

void WsfIterativeRouteMover::SetGuidance ( WsfPathGuidance * aGuidancePtr )

inlineprotected

Referenced by WsfRotorcraftMover::WsfRotorcraftMover().

◆ SetGuidanceFrom()

void WsfIterativeRouteMover::SetGuidanceFrom ( const WsfWaypoint & aPreviousWaypoint )

overridevirtual

Mover implementing this method should adjust current constraints to comply with those in aPreviousWaypoint.

Implements WsfRouteMover.

References WsfPath::cDOUBLE_NOT_SET, WsfPath::cSWITCH_ON_APPROACH, WsfPath::cTURN_DIR_SHORTEST, WsfWaypoint::GetAlt(), WsfWaypoint::GetAltRef(), WsfWaypoint::GetClimbRate(), WsfWaypoint::GetLinearAccel(), WsfWaypoint::GetRadialAccel(), WsfWaypoint::GetSpeed(), and WsfWaypoint::GetSwitch().

◆ SetGuidanceTo()

void WsfIterativeRouteMover::SetGuidanceTo ( const WsfWaypoint & aNextWaypoint )

overridevirtual

Mover implementing this method should adjust current constraints to comply with those in aNextWaypoint.

Implements WsfRouteMover.

References WsfPath::cALT_REF_MSL, WsfPath::cDOUBLE_NOT_SET, WsfWaypoint::cLATITUDE_AND_LONGITUDE, WsfWaypoint::GetAlt(), WsfRouteMover::GetAltRef(), WsfWaypoint::GetAltRef(), WsfWaypoint::GetLat(), WsfWaypoint::GetLon(), WsfPlatformPart::GetPlatform(), WsfWaypoint::GetPointType(), and WsfWaypoint::GetSpeed().

◆ SetIsOnGround()

void WsfIterativeRouteMover::SetIsOnGround ( bool aValue )

inlineprotected

◆ SetMinTurnRadius()

void WsfIterativeRouteMover::SetMinTurnRadius ( double aValue )

inlineprotected

◆ TurnToHeading()

bool WsfIterativeRouteMover::TurnToHeading	(	double	aSimTime,
		double	aHeading,
		double	aRadialAccel,
		WsfPath::TurnDirection	aTurnDirection )

overridevirtual

Command the mover to change its heading.

Parameters

aSimTime	The current simulated clock time (seconds).
aHeading	The desired heading (in radians).
aRadialAccel	The desired radial acceleration (meters/second^2). If zero then use the mover default.
aTurnDirection	The direction in which to turn.

Returns: true if successful.

Reimplemented from WsfMover.

Reimplemented in WsfRotorcraftMover.

References WsfPath::cHDG_REF_NORTH, WsfPathGuidance::cLAT_LON, WsfPath::cTURN_DIR_LEFT, WsfPath::cTURN_DIR_RIGHT, WsfPath::cTURN_DIR_SHORTEST, WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), and WsfPlatformPart::GetPlatform().

Referenced by WsfRotorcraftMover::TurnToHeading(), and TurnToRelativeHeading().

◆ TurnToRelativeHeading()

bool WsfIterativeRouteMover::TurnToRelativeHeading	(	double	aSimTime,
		double	aHeadingChange,
		double	aRadialAccel,
		WsfPath::TurnDirection	aTurnDirection )

overridevirtual

Command the mover to change its relative heading.

Parameters

aSimTime	The current simulated clock time (seconds).
aHeadingChange	The desired heading change with positive clockwise, negative counter-clockwise. (in radians).
aRadialAccel	The desired radial acceleration (meters/second^2). If zero then use the mover default.
aTurnDirection	The direction in which to turn.

Returns: true if successful.

Reimplemented from WsfMover.

References WsfPlatformPart::GetPlatform(), and TurnToHeading().

◆ UpdatePosition()

void WsfIterativeRouteMover::UpdatePosition ( double aSimTime )

overridevirtual

Implements WsfRouteMover.

References AdvanceTime(), WsfRouteMover::IsPaused(), WsfMover::IsStopped(), WsfMover::mLastUpdateTime, WsfMover::mUpdateTimeTolerance, WsfRouteMover::Update(), and WsfRouteMover::WaypointReached().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfIterativeRouteMover() [1/3]

◆ WsfIterativeRouteMover() [2/3]

◆ WsfIterativeRouteMover() [3/3]

◆ ~WsfIterativeRouteMover()

Member Function Documentation

◆ AdvanceTime()

◆ AdvanceToNextWaypoint()

◆ CalcAltitudesAndAttitude()

◆ ClearConverging()

◆ CumSegmentDist()

◆ CumSegmentTime()

◆ GetConverging()

◆ GetGuidance()

◆ GetHeightOfTerrain()

◆ GetIsInAir()

◆ GetIsOnGround()

◆ GetMinTurnRadius()

◆ GetTurnLeadDistance()

◆ GoToAltitude()

◆ GoToLocation()

◆ GoToSpeed()

◆ IncrSegmentDist()

◆ IncrSegmentTime()

◆ Initialize()

◆ IsWaypointSwitchTime()

◆ LocalUpdate()

◆ operator=()

◆ Pause()

◆ PostMoveUpdate()

◆ ProcessInput()

◆ ResetWPSwitching()

◆ SegmentDistRemaining()

◆ SegmentTimeRemaining()

◆ SetConverging()

◆ SetGroundAttitude()

◆ SetGuidance()

◆ SetGuidanceFrom()

◆ SetGuidanceTo()

◆ SetIsOnGround()

◆ SetMinTurnRadius()

◆ TurnToHeading()

◆ TurnToRelativeHeading()

◆ UpdatePosition()