WsfRouteFinder Class Reference

#include <WsfRouteFinder.hpp>

Inheritance diagram for WsfRouteFinder:

Collaboration diagram for WsfRouteFinder:

Public Types
enum	ImpossibleRouteResponse { SHRINK_AVOIDANCES = 1 , SHIFT_OUTSIDE_AVOIDANCES = 2 , IGNORE_IMPOSSIBLE_AVOIDANCES = 3 }
enum	OrientationAround { CLOCKWISE = 0x01 , COUNTERCLOCKWISE = 0x02 , NEITHER = 0x03 }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfRouteFinder (WsfSimulation *aSimulationPtr)
	WsfRouteFinder (const WsfRouteFinder &aSrc)
WsfRouteFinder &	operator= (const WsfRouteFinder &)=delete
	~WsfRouteFinder () override
WsfRouteFinder *	Clone () const override
void	Avoid (WsfPlatform &aPlatform, double aRadius)
void	Avoid (const WsfGeoPoint &aPoint, double aRadius)
void	ClearAvoidances ()
WsfRoute *	Route (double aTime, const WsfGeoPoint &aFrom, const WsfGeoPoint &aTo, double speed, int branchIndex=0)
WsfRoute *	RouteAvoidances ()
void	DrawRoute (double duration, const UtVec3d &color)
void	DrawGraph (double duration, const UtVec3d &color)
void	DrawAvoidances (double duration, const UtVec3d &color)
ImpossibleRouteResponse	GetImpossibleRouteResponse (void)
void	SetImpossibleRouteResponse (ImpossibleRouteResponse aResponse)
void	SetMaxArcLength (double aArcLength)
WsfSimulation *	GetSimulation () const
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
virtual bool	ProcessInput (UtInput &aInput)
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)

Static Public Member Functions
static std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)

Additional Inherited Members
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Member Enumeration Documentation

ImpossibleRouteResponse

enum WsfRouteFinder::ImpossibleRouteResponse

Enumerator
SHRINK_AVOIDANCES
SHIFT_OUTSIDE_AVOIDANCES
IGNORE_IMPOSSIBLE_AVOIDANCES

OrientationAround

enum WsfRouteFinder::OrientationAround

Enumerator
CLOCKWISE
COUNTERCLOCKWISE
NEITHER

Constructor & Destructor Documentation

WsfRouteFinder() [1/2]

WsfRouteFinder::WsfRouteFinder

(

WsfSimulation *

aSimulationPtr

)

References WsfDraw::cELLIPSE_LINE, WsfDraw::cFOREVER, WsfDraw::cSOLID, and SHRINK_AVOIDANCES.

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

WsfRouteFinder() [2/2]

WsfRouteFinder::WsfRouteFinder

(

const WsfRouteFinder &

aSrc

)

References WsfRouteFinder().

~WsfRouteFinder()

WsfRouteFinder::~WsfRouteFinder ( )

override

Member Function Documentation

Avoid() [1/2]

void WsfRouteFinder::Avoid	(	const WsfGeoPoint &	aPoint,
		double	aRadius )

Avoid() [2/2]

void WsfRouteFinder::Avoid	(	WsfPlatform &	aPlatform,
		double	aRadius )

References WsfPlatform::GetIndex().

ClearAvoidances()

void WsfRouteFinder::ClearAvoidances

(

)

Clone()

WsfRouteFinder * WsfRouteFinder::Clone ( ) const

inlineoverridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

References WsfRouteFinder().

Referenced by WsfScriptRouteFinderClass::Clone().

CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfRouteFinder::CreateScriptClass ( const std::string & aClassName, UtScriptTypes * aScriptTypesPtr )

static

Referenced by WsfScriptManager::RegisterTypes().

DrawAvoidances()

void WsfRouteFinder::DrawAvoidances	(	double	duration,
		const UtVec3d &	color )

DrawGraph()

void WsfRouteFinder::DrawGraph	(	double	duration,
		const UtVec3d &	color )

DrawRoute()

void WsfRouteFinder::DrawRoute	(	double	duration,
		const UtVec3d &	color )

References WsfGeoPoint::GetAlt(), WsfGeoPoint::GetLat(), and WsfGeoPoint::GetLon().

GetImpossibleRouteResponse()

ImpossibleRouteResponse WsfRouteFinder::GetImpossibleRouteResponse ( void )

inline

GetSimulation()

WsfSimulation * WsfRouteFinder::GetSimulation ( ) const

inline

Referenced by Route().

operator=()

WsfRouteFinder & WsfRouteFinder::operator= ( const WsfRouteFinder & )

delete

References WsfRouteFinder().

Route()

WsfRoute * WsfRouteFinder::Route	(	double	aTime,
		const WsfGeoPoint &	aFrom,
		const WsfGeoPoint &	aTo,
		double	speed,
		int	branchIndex = 0 )

References CLOCKWISE, WsfRoute::Clone(), COUNTERCLOCKWISE, WsfGeoPoint::GetAlt(), WsfGeoPoint::GetDistanceFrom(), WsfGeoPoint::GetLat(), WsfGeoPoint::GetLocationWCS(), WsfGeoPoint::GetLon(), WsfSimulation::GetPlatformByIndex(), GetSimulation(), IGNORE_IMPOSSIBLE_AVOIDANCES, platformPtr, WsfGeoPoint::SetAltitudeMSL(), WsfWaypoint::SetRadialAccel(), SHIFT_OUTSIDE_AVOIDANCES, and SHRINK_AVOIDANCES.

RouteAvoidances()

WsfRoute * WsfRouteFinder::RouteAvoidances

(

)

References WsfRoute::Clone().

SetImpossibleRouteResponse()

void WsfRouteFinder::SetImpossibleRouteResponse ( ImpossibleRouteResponse aResponse )

inline

SetMaxArcLength()

void WsfRouteFinder::SetMaxArcLength ( double aArcLength )

inline

---

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

• WsfRouteFinder.hpp
• WsfRouteFinder.cpp