CartoType .NET API 8.8-7-gb35e4dc71
for development in C#, Visual Basic and other .NET languages
Public Member Functions | Properties | 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

virtual int ContourCount ()
 Returns the number of contours (sub-paths). It is always 1 for this class. More...
 
virtual int PointCount (int aContourIndex)
 Returns the number of points in a contour. More...
 
virtual PathPointPoint (int aContourIndex, int aPointIndex)
 Returns a point given its contour and point indexes. More...
 
int ContourCount ()
 Returns the number of contours (sub-paths). More...
 
int PointCount (int aContourIndex)
 Returns the number of points in a contour. More...
 
PathPointPoint (int aContourIndex, int aPointIndex)
 Returns a point given its contour and point indexes. More...
 

Properties

FeatureInfoFeatureInfo [get]
 Returns the feature info of the object of which this segment is a part.
 
String^ Name [get]
 Returns the standard name of the object of which this segment is a part.
 
String^ Ref [get]
 Returns the road reference of the object of which this segment is a part.
 
double Distance [get]
 Returns the distance in metres.
 
double Time [get]
 Returns the estimated time taken to traverse the segment in seconds, including the turn time returned by TurnTime().
 
double TurnTime [get]
 Returns the estimated time taken by the turn at the start of the segment; this is included in the value returned by Time().
 
TurnType TurnType [get]
 Returns the turn type.
 
bool IsContinue [get]
 Returns true if this is a 'continue' turn, false if not.
 
RoundaboutState RoundaboutState [get]
 Returns the roundabout state.
 
double TurnAngle [get]
 Returns the turn angle.
 
int ExitNumber [get]
 Returns the exit number, counting the current junction as 0, if this junction is part of a roundabout.
 
int Choices [get]
 Returns the number of choices at this turning if known; 0 if not known.
 
int Section [get]
 Returns the route section this segment belongs to.
 

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

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

Implements CartoType::Path.

◆ Point()

virtual PathPoint ^ CartoType::RouteSegment::Point ( int  aContourIndex,
int  aPointIndex 
)
virtual

Returns a point given its contour and point indexes.

Implements CartoType::Path.

◆ PointCount()

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

Returns the number of points in a contour.

Implements CartoType::Path.


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