WsfRouteNetwork::RoutePoint Class Reference

Specifies a location along a route. More...

#include <WsfRouteNetwork.hpp>

Public Member Functions
	RoutePoint ()=default
	RoutePoint (const WaypointAddr &aAddr, double aDistanceAlongSegment=0)
int	RouteIndex () const
int	WaypointIndex () const

Public Attributes
WaypointAddr	mWaypointAddr
	Waypoint and route index.
double	mDistanceAlongSegment = 0.0
	Distance from the waypoint addressed toward the next waypoint.

Detailed Description

Specifies a location along a route.

Constructor & Destructor Documentation

RoutePoint() [1/2]

WsfRouteNetwork::RoutePoint::RoutePoint ( )

default

RoutePoint() [2/2]

WsfRouteNetwork::RoutePoint::RoutePoint ( const WaypointAddr & aAddr, double aDistanceAlongSegment = 0 )

inline

References mDistanceAlongSegment, and mWaypointAddr.

Member Function Documentation

RouteIndex()

int WsfRouteNetwork::RoutePoint::RouteIndex ( ) const

inline

References mWaypointAddr.

Referenced by WsfRouteNetwork::AppendShortestPathOnNetwork(), WsfRouteNetwork::AppendSubroute(), WsfRouteNetwork::GetAdjacentNodeIndices(), and UT_DEFINE_SCRIPT_METHOD().

WaypointIndex()

int WsfRouteNetwork::RoutePoint::WaypointIndex ( ) const

inline

References mWaypointAddr.

Referenced by WsfRouteNetwork::AppendShortestPathOnNetwork(), WsfRouteNetwork::AppendSubroute(), WsfRouteNetwork::GetAdjacentNodeIndices(), and UT_DEFINE_SCRIPT_METHOD().

Member Data Documentation

mDistanceAlongSegment

double WsfRouteNetwork::RoutePoint::mDistanceAlongSegment = 0.0

Distance from the waypoint addressed toward the next waypoint.

Referenced by WsfRouteNetwork::Append(), WsfRouteNetwork::AppendShortestPathOnNetwork(), WsfRouteNetwork::AppendSubroute(), WsfRouteNetwork::FindClosestSegment(), WsfRouteNetwork::GetAdjacentNodeIndices(), and RoutePoint().

mWaypointAddr

WaypointAddr WsfRouteNetwork::RoutePoint::mWaypointAddr

Waypoint and route index.

Referenced by WsfRouteNetwork::Append(), WsfRouteNetwork::AppendShortestPathOnNetwork(), WsfRouteNetwork::FindClosestSegment(), RouteIndex(), RoutePoint(), and WaypointIndex().

---

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

• WsfRouteNetwork.hpp