WsfZoneRouteFinder Class Reference

#include <WsfZoneRouteFinder.hpp>

Inheritance diagram for WsfZoneRouteFinder:

Collaboration diagram for WsfZoneRouteFinder:

Public Member Functions
	WsfZoneRouteFinder (WsfSimulation *aSimulationPtr)
	WsfZoneRouteFinder (const WsfZoneRouteFinder &aSrc)
	~WsfZoneRouteFinder () override
WsfZoneRouteFinder &	operator= (const WsfZoneRouteFinder &)=delete
WsfZoneRouteFinder *	Clone () const override
void	ClearAvoidanceZones ()
void	DrawGraph (double aDuration, const UtVec3d &aColor)
void	DrawAvoidances (double aDuration, const UtVec3d &aColor)
WsfSimulation *	GetSimulation () const
void	AvoidZone (WsfZone *aZonePtr)
const WsfZone *	GetAvoidanceZone (size_t aIndex) const noexcept
size_t	NumberOfAvoidanceZones () const noexcept
WsfRoute *	RouteAroundZones (const WsfGeoPoint &aFrom, const WsfGeoPoint &aTo, double aSpeed)
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
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Constructor & Destructor Documentation

WsfZoneRouteFinder() [1/2]

WsfZoneRouteFinder::WsfZoneRouteFinder

(

WsfSimulation *

aSimulationPtr

)

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

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

WsfZoneRouteFinder() [2/2]

WsfZoneRouteFinder::WsfZoneRouteFinder

(

const WsfZoneRouteFinder &

aSrc

)

References WsfZoneRouteFinder().

~WsfZoneRouteFinder()

WsfZoneRouteFinder::~WsfZoneRouteFinder ( )

override

Member Function Documentation

AvoidZone()

void WsfZoneRouteFinder::AvoidZone

(

WsfZone *

aZonePtr

)

References WsfZoneDefinition::cINTERNAL, WsfZoneDefinition::cPOLYGONAL, WsfObject::GetName(), WsfZoneDefinition::GetPoints(), WsfZoneDefinition::GetRelativeType(), WsfZoneDefinition::GetShapeType(), and WsfZoneDefinition::PointsAreLatLon().

ClearAvoidanceZones()

void WsfZoneRouteFinder::ClearAvoidanceZones

(

)

Clone()

WsfZoneRouteFinder * WsfZoneRouteFinder::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 WsfZoneRouteFinder().

Referenced by WsfScriptZoneRouteFinderClass::Clone().

CreateScriptClass()

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

static

Referenced by WsfScriptManager::RegisterTypes().

DrawAvoidances()

void WsfZoneRouteFinder::DrawAvoidances	(	double	aDuration,
		const UtVec3d &	aColor )

DrawGraph()

void WsfZoneRouteFinder::DrawGraph	(	double	aDuration,
		const UtVec3d &	aColor )

GetAvoidanceZone()

const WsfZone * WsfZoneRouteFinder::GetAvoidanceZone ( size_t aIndex ) const

noexcept

Get avoidance zone

Parameters

aIndex

is the index of the avoidance zone

Returns

the entry at the specified index in the list of avoidance zones

GetSimulation()

WsfSimulation * WsfZoneRouteFinder::GetSimulation ( ) const

inline

NumberOfAvoidanceZones()

size_t WsfZoneRouteFinder::NumberOfAvoidanceZones ( ) const

inlinenoexcept

Get the number of avoidance zones

Returns

the number of avoidance zones

operator=()

WsfZoneRouteFinder & WsfZoneRouteFinder::operator= ( const WsfZoneRouteFinder & )

delete

References WsfZoneRouteFinder().

RouteAroundZones()

WsfRoute * WsfZoneRouteFinder::RouteAroundZones	(	const WsfGeoPoint &	aFrom,
		const WsfGeoPoint &	aTo,
		double	aSpeed )

References WsfRoute::Append(), WsfGeoPoint::GetAlt(), WsfGeoPoint::GetDistanceFrom(), WsfGeoPoint::GetLat(), WsfGeoPoint::GetLon(), WsfZoneDefinition::GetPoints(), and WsfGeoPoint::SetAltitudeMSL().

---

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

• WsfZoneRouteFinder.hpp
• WsfZoneRouteFinder.cpp