CartoType .NET API 7.8.2, 2022-03-25
for development in C#, Visual Basic and other .NET languages
Public Member Functions | List of all members
CartoType::RouteSegment Class Reference

Part of a route, consisting of a turn and the section of the route from that turn to the next one. More...

#include <CartoTypeWrapper.h>

Inheritance diagram for CartoType::RouteSegment:
CartoType::Path

Public Member Functions

RoadType GetRoadType ()
 Gets the road type of the object of which this segment is a part.
 
double GetMaxSpeed ()
 Gets the maximum speed in kilometers per hour, or 0 if no maximum speed is known.
 
String ^ GetName ()
 Gets the standard name of the object of which this segment is a part.
 
String ^ GetRef ()
 Gets the road reference of the object of which this segment is a part.
 
double GetDistance ()
 Gets the distance in metres.
 
double GetTime ()
 Gets the estimated time taken to traverse the segment in seconds, including the turn time returned by GetTurnTime().
 
double GetTurnTime ()
 Gets the estimated time taken by the turn at the start of the segment; this is included in the value returned by GetTime().
 
TurnType GetTurnType ()
 Gets the turn type.
 
bool GetContinue ()
 Returns true if this is a 'continue' turn, false if not.
 
RoundaboutState GetRoundaboutState ()
 Gets the roundabout state.
 
double GetTurnAngle ()
 Gets the turn angle.
 
int GetExitNumber ()
 Gets the exit number, counting the current junction as 0, if this junction is part of a roundabout.
 
int GetChoices ()
 Gets the number of choices at this turning if known; 0 if not known.
 
int GetSection ()
 Gets the route section this segment belongs to.
 
virtual int ContourCount ()
 Gets the number of contours (sub-paths). It is always 1 for this class. More...
 
virtual int PointCount (int aContourIndex)
 Gets the number of points in a contour. More...
 
virtual void GetPoint (int aContourIndex, int aPointIndex, PathPoint^ aPoint)
 Gets a point given its contour and point indexes. More...
 
int ContourCount ()
 Gets the number of contours (sub-paths). More...
 
int PointCount (int aContourIndex)
 Gets the number of points in a contour. More...
 
void GetPoint (int aContourIndex, int aPointIndex, PathPoint^ aPoint)
 Gets a point given its contour and point indexes. More...
 

Detailed Description

Part of a route, consisting of a turn and the section of the route from that turn to the next one.

Member Function Documentation

◆ ContourCount()

virtual int CartoType::RouteSegment::ContourCount ( )
inlinevirtual

Gets the number of contours (sub-paths). It is always 1 for this class.

Implements CartoType::Path.

◆ GetPoint()

virtual void CartoType::RouteSegment::GetPoint ( int  aContourIndex,
int  aPointIndex,
PathPoint aPoint 
)
virtual

Gets a point given its contour and point indexes.

Implements CartoType::Path.

◆ PointCount()

virtual int CartoType::RouteSegment::PointCount ( int  aContourIndex)
virtual

Gets the number of points in a contour.

Implements CartoType::Path.


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