CartoTypeRouter.h

Go to the documentation of this file.

/*
CartoTypeRouter.h
Copyright 2013-2024 CartoType Ltd.
See www.cartotype.com for more information.
*/
 
#ifndef CartoTypeRouter_h__
#define CartoTypeRouter_h__
 
#import <CartoType/CartoTypeBase.h>


static const uint32_t CtMaxRoutesDisplayed = 16;

typedef NS_ENUM(NSInteger,CtRouteProfileType)
    {
    CtRouteProfileTypeCar,
    CtRouteProfileTypeWalk,
    CtRouteProfileTypeBike,
    CtRouteProfileTypeCycle = CtRouteProfileTypeBike,
    CtRouteProfileTypeHike,
    CtRouteProfileTypeSki
    };

typedef CtRouteProfileType CartoTypeRouteProfileType;

@interface CtRouteProfile: NSObject
    -(id)init;

    -(id)initWithProfileType:(CtRouteProfileType)aProfileType;

    @property (nonatomic, strong) NSString* name;
        
    @property (nonatomic) uint32_t vehicleType;
    
    @property (nonatomic) double weight;
    
    @property (nonatomic) double axleLoad;
    
    @property (nonatomic) double doubleAxleLoad;

    @property (nonatomic) double tripleAxleLoad;

    @property (nonatomic) double height;
    
    @property (nonatomic) double width;
    
    @property (nonatomic) double length;
    
    @property (nonatomic) bool hazMat;
    
    -(double)speed:(unsigned int)aIndex;
    -(void)setSpeed:(unsigned int)aIndex to:(double)aValue;
    -(double)bonus:(unsigned int)aIndex;
    -(void)setBonus:(unsigned int)aIndex to:(double)aValue;

    -(uint32_t)restrictionOverride:(unsigned int)aIndex;
    -(void)setRestrictionOverride:(unsigned int)aIndex to:(uint32_t)aValue;

    @property (nonatomic) int turnTime;
    
    @property (nonatomic) int uTurnTime;

    @property (nonatomic) int crossTrafficTurnTime;
    
    @property (nonatomic) int trafficLightTime;
    
    @property (nonatomic) bool shortest;
    
    @property (nonatomic) bool shortestByTime;

    @property (nonatomic) double tollPenalty;

    -(double)gradientSpeed:(unsigned int)aIndex;
    -(void)setGradientSpeed:(unsigned int)aIndex to:(double)aValue;

    -(double)gradientBonus:(unsigned int)aIndex;
    -(void)setGradientBonus:(unsigned int)aIndex to:(double)aValue;
    
    @property (nonatomic) uint32_t gradientFlags;

    -(void*)profile;
@end
@compatibility_alias CartoTypeRouteProfile CtRouteProfile;

typedef NS_ENUM(NSInteger,CtRouterType)
    {
    CtRouterTypeDefault,
    CtRouterTypeStandardAStar,
    CtRouterTypeTurnExpandedAStar,
    CtRouterTypeStandardContractionHierarchy,
    CtRouterTypeTECH
    };

typedef CtRouterType CartoTypeRouterType;

typedef NS_ENUM(NSInteger,CtTurnType)
    {
    CtTurnTypeNone,
    CtTurnTypeAhead,
    CtTurnTypeBearRight,
    CtTurnTypeRight,
    CtTurnTypeSharpRight,
    CtTurnTypeAround,
    CtTurnTypeSharpLeft,
    CtTurnTypeLeft,
    CtTurnTypeBearLeft
    };

typedef CtTurnType CartoTypeTurnType;

typedef NS_ENUM(NSInteger,CtRoundaboutState)
    {
    CtRoundaboutStateNone,
    CtRoundaboutStateEnter,
    CtRoundaboutStateContinue,
    CtRoundaboutStateExit
    };

typedef CtRoundaboutState CartoTypeRoundaboutState;

@interface CtTurn: NSObject
    @property (nonatomic) CtTurnType turnType;
    @property (nonatomic) bool isContinue;
    @property (nonatomic) CtRoundaboutState roundaboutState;
    @property (nonatomic) double turnAngle;
    @property (nonatomic) int exitNumber;
    @property (nonatomic) double distance;
    @property (nonatomic) double time;
    @property (nonatomic, strong) NSString* fromName;
    @property (nonatomic, strong) NSString* fromRef;
    @property (nonatomic) CtFeatureInfo* fromRouteInfo;
    @property (nonatomic, strong) NSString* toName;
    @property (nonatomic, strong) NSString* toRef;
    @property (nonatomic) CtFeatureInfo* toRouteInfo;
    @property (nonatomic, strong) NSString* destination;
    @property (nonatomic) CtPoint position;
    @property (nonatomic, strong) NSString* instructions;
    @property (nonatomic) int index;
@end
@compatibility_alias CartoTypeTurn CtTurn;

typedef NS_ENUM(NSInteger,CtSideOfRoad)
    {
    CtSideOfRoadNone,
    CtSideOfRoadRight,
    CtSideOfRoadLeft,
    CtSideOfRoadBoth
    };

typedef CtSideOfRoad CartoTypeSideOfRoad;

@interface CtNearestRoadInfo: NSObject
    @property (nonatomic, strong) CtFeatureInfo* featureInfo;
    @property (nonatomic) double maxSpeed;
    @property (nonatomic, strong) NSString* name;
    @property (nonatomic, strong) NSString* ref;
    @property (nonatomic) CtPoint nearestPoint;
    @property (nonatomic) double distance;
    @property (nonatomic) double headingInDegrees;
    @property (nonatomic) CtPoint headingVector;
    @property (nonatomic) CtSideOfRoad sideOfRoad;
@end
@compatibility_alias CartoTypeNearestRoadInfo CtNearestRoadInfo;

@interface CtLocationMatchParam: NSObject
    -(id)init;
    @property (nonatomic) double locationAccuracyInMeters;
    @property (nonatomic) double headingAccuracyInDegrees;
    @property (nonatomic) double maxRoadDistanceInMeters;
@end
@compatibility_alias CartoTypeLocationMatchParam CtLocationMatchParam;

@interface CtRoutePoint: NSObject
    @property (nonatomic) CtPoint point;
    @property (nonatomic) double heading;
    @property (nonatomic) bool headingKnown;
    @property (nonatomic, strong) CtLocationMatchParam* locationMatchParam;
    -(void*)routePoint;
@end
@compatibility_alias CartoTypeRoutePoint CtRoutePoint;

@interface CtRouteCoordSet: NSObject
    @property (nonatomic) CtCoordType coordType;
    -(void)append:(CtRoutePoint*)aPoint;
    -(int)pointCount;
    -(CtRoutePoint*)point:(int)aIndex;
    -(void*)routeCoordSet;
@end
@compatibility_alias CartoTypeRouteCoordSet CtRouteCoordSet;

@interface CtPointSet: NSObject
    -(id)init:(CtCoordType)aCoordType;
    @property (nonatomic, readonly) CtCoordType coordType;
    -(void)append:(CtPoint)aPoint;
    -(int)pointCount;
    -(CtPoint)point:(int)aIndex;
    -(void*)pointVector;
@end
@compatibility_alias CartoTypePointSet CtPointSet;

typedef NS_OPTIONS(uint32_t,CtNavigationDataValid)
    {
    CtNavigationDataValidTime = 1,
    CtNavigationDataValidPosition = 2,
    CtNavigationDataValidSpeed = 4,
    CtNavigationDataValidCourse = 8,
    CtNavigationDataValidHeight = 16
    };

typedef CtNavigationDataValid CartoTypeNavigationDataValid;

typedef struct
    {
    CtNavigationDataValid validity;
    double time;
    double longitude;
    double latitude;
    double speed;
    double course;
    double height;
    } CtNavigationData;

typedef CtNavigationData CartoTypeNavigationData;

typedef NS_ENUM(NSInteger,CtNavigationState)
    {
    CtNavigationStateNone,
    CtNavigationStateNoPosition,
    CtNavigationStateTurn,
    CtNavigationStateOffRoute,
    CtNavigationStateRouting,
    CtNavigationStateNewRoute,
    CtNavigationStateTurnRound,
    CtNavigationStateArrival,
    CtNavigationStateDeparture
    };

typedef CtNavigationState CartoTypeNavigationState;
 
typedef NS_OPTIONS(uint32_t,CtFollowMode)
    {
    CtFollowModeLocationFlag = 1,
    CtFollowModeHeadingFlag = 2,
    CtFollowModeZoomFlag = 4,
    CtFollowModeNone = 0,
    CtFollowModeLocation = CtFollowModeLocationFlag,
    CtFollowModeLocationHeading = CtFollowModeLocationFlag | CtFollowModeHeadingFlag,
    CtFollowModeLocationZoom = CtFollowModeLocationFlag | CtFollowModeZoomFlag,
    CtFollowModeLocationHeadingZoom = CtFollowModeLocationFlag | CtFollowModeHeadingFlag | CtFollowModeZoomFlag
    };

typedef CtFollowMode CartoTypeFollowMode;

typedef struct
    {
    int segmentIndex;
    int lineIndex;
    CtPoint nearestPoint;
    double distanceToRoute;
    double distanceAlongRoute;
    double distanceAlongSegment;
    double timeAlongRoute;
    double timeAlongSegment;
    double heading;
    } CtNearestSegmentinfo;

typedef CtNearestSegmentinfo CartoTypeNearestSegmentinfo;

@interface CtRouteSegment: NSObject <CtPath>
    -(id)initWithRouteSegmentObject:(void*)aRouteSegmentObject;
    -(CtFeatureInfo*)featureInfo;
    -(NSString*)name;
    -(NSString*)ref;
    -(NSString*)destination;
    -(double)distance;
    -(double)time;
    -(double)turnTime;
    -(CtTurnType)turnType;
    -(bool)isContinue;
    -(CtRoundaboutState)roundaboutState;
    -(double)turnAngle;
    -(int)exitNumber;
    -(int)choices;
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CtPathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    -(int)section;
    -(NSString*)instructions;
    @end
@compatibility_alias CartoTypeRouteSegment CtRouteSegment;

@interface CtRoute: NSObject <CtPath>
    -(id)initWithRouteObject:(void*)aRouteObject;
    -(CtGeometry*)geometry;
    -(double)distance;
    -(double)tollRoadDistance;
    -(double)time;
    -(int)routeSegmentCount;
    -(CtRouteSegment*)routeSegmentByIndex:(int)aIndex;
    -(void)nearestSegment:(CtPoint)aPoint info:(CtNearestSegmentinfo*)aInfo section:(int)aSection prevDistance:(double)aPreviousDistanceAlongRoute;
    -(void)pointAtDistance:(double)aDistanceInMeters info:(CtNearestSegmentinfo*)aInfo;
    -(void)pointAtTime:(double)aTimeInSeconds info:(CtNearestSegmentinfo*)aInfo;
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CtPathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    -(void*)route;
@end
@compatibility_alias CartoTypeRoute CtRoute;

typedef struct
    {
    uint32_t vehicleTypes;
    double speed;
    } CtTrafficInfo;

typedef CtTrafficInfo CartoTypeTrafficInfo;

typedef NS_ENUM(NSInteger,CtRoadOrientation)
    {
    CtRoadOrientationNone,
    CtRoadOrientationForwards,
    CtRoadOrientationBackwards,
    CtRoadOrientationBoth,
    };

typedef CtRoadOrientation CartoTypeRoadOrientation;

typedef NS_ENUM(NSInteger,CtLocationRefType)
    {
    CtLocationRefTypeLine,
    CtLocationRefTypeGeoCoordinate,
    CtLocationRefTypePointAlongLine,
    CtLocationRefTypePointWithAccessPoint,
    CtLocationRefTypeCircle,
    CtLocationRefTypeRectangle,
    CtLocationRefTypePolygon,
    CtLocationRefTypeClosedLine
    };

typedef CtLocationRefType CartoTypeLocationRefType;

typedef struct
    {
    CtLocationRefType type;
    __unsafe_unretained NSString* identifier;
    __unsafe_unretained CtGeometry* geometry;
    double radiusInMeters;
    CtSideOfRoad sideOfRoad;
    CtRoadOrientation roadOrientation;
    } CtLocationRef;

typedef CtLocationRef CartoTypeLocationRef;

@interface CtNavigatorParam: NSObject
    @property (nonatomic) int minimumFixDistance;
    @property (nonatomic) int routeDistanceTolerance;
    @property (nonatomic) int routeTimeTolerance;
    @property (nonatomic) bool navigationEnabled;
    -(void*)navigatorParam;
@end
@compatibility_alias CartoTypeNavigatorParam CtNavigatorParam;

@interface CtTimeAndDistanceMatrix: NSObject
    @property (nonatomic, readonly) int fromCount;
    @property (nonatomic, readonly) int toCount;
    -(int)time:(int)aFromIndex to:(int)aToIndex;
    -(int)distance:(int)aFromIndex to:(int)aToIndex;
    -(id)initWithMatrix:(void*)aMatrix;
@end
@compatibility_alias CartoTypeTimeAndDistanceMatrix CtTimeAndDistanceMatrix;
 
#endif