CartoTypeRouter.h

Go to the documentation of this file.

/*
CartoTypeRouter.h
Copyright 2013-2023 CartoType Ltd.
See www.cartotype.com for more information.
*/
 
#ifndef CartoTypeRouter_h__
#define CartoTypeRouter_h__
 
#import <CartoType/CartoTypeBase.h>
 
static const uint32_t KMaxRoutesDisplayed = 16;
 
typedef enum
    {
    CarProfile,
    WalkingProfile,
    BicycleProfile,
    HikingProfile,
    SkiProfile
    } CartoTypeRouteProfileType;
 
@interface CartoTypeRouteProfile: NSObject
    -(id)init;
 
    -(id)initWithProfileType:(CartoTypeRouteProfileType)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
 
typedef enum
    {
    RouterTypeDefault,
    RouterTypeStandardAStar,
    RouterTypeTurnExpandedAStar,
    RouterTypeStandardContractionHierarchy,
    RouterTypeTECH
    } CartoTypeRouterType;
 
typedef enum
    {
    TurnTypeNone, 
    TurnTypeAhead,
    TurnTypeBearRight,
    TurnTypeRight,
    TurnTypeSharpRight,
    TurnTypeAround,
    TurnTypeSharpLeft,
    TurnTypeLeft,
    TurnTypeBearLeft
    } CartoTypeTurnType;
 
typedef enum
    {
    RoundaboutStateNone,
    RoundaboutStateEnter,
    RoundaboutStateContinue,
    RoundaboutStateExit
    } CartoTypeRoundaboutState;
 
@interface CartoTypeTurn: NSObject
    @property (nonatomic) CartoTypeTurnType turnType;
    @property (nonatomic) bool isContinue;
    @property (nonatomic) CartoTypeRoundaboutState 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) CartoTypeFeatureInfo* fromRouteInfo;
    @property (nonatomic, strong) NSString* toName;
    @property (nonatomic, strong) NSString* toRef;
    @property (nonatomic) CartoTypeFeatureInfo* toRouteInfo;
    @property (nonatomic) CartoTypePoint position;
    @property (nonatomic, strong) NSString* instructions;
@end
 
typedef enum
    {
    SideOfRoadNone,
    SideOfRoadRight,
    SideOfRoadLeft,
    SideOfRoadBoth
    } CartoTypeSideOfRoad;
 
@interface CartoTypeNearestRoadInfo: NSObject
    @property (nonatomic, strong) CartoTypeFeatureInfo* featureInfo;
    @property (nonatomic) double maxSpeed;
    @property (nonatomic, strong) NSString* name;
    @property (nonatomic, strong) NSString* ref;
    @property (nonatomic) CartoTypePoint nearestPoint;
    @property (nonatomic) double distance;
    @property (nonatomic) double headingInDegrees;
    @property (nonatomic) CartoTypePoint headingVector;
    @property (nonatomic) CartoTypeSideOfRoad sideOfRoad;
@end
 
@interface CartoTypeLocationMatchParam: NSObject
    -(id)init;
    @property (nonatomic) double locationAccuracyInMeters;
    @property (nonatomic) double headingAccuracyInDegrees;
    @property (nonatomic) double maxRoadDistanceInMeters;
@end
 
@interface CartoTypeRoutePoint: NSObject
    @property (nonatomic) CartoTypePoint point;
    @property (nonatomic) double heading;
    @property (nonatomic) bool headingKnown;
    @property (nonatomic, strong) CartoTypeLocationMatchParam* locationMatchParam;
    -(void*)routePoint;
@end
 
@interface CartoTypeRouteCoordSet: NSObject
    @property (nonatomic) CartoTypeCoordType coordType;
    -(void)append:(CartoTypeRoutePoint*)aPoint;
    -(int)pointCount;
    -(CartoTypeRoutePoint*)point:(int)aIndex;
    -(void*)routeCoordSet;
@end
 
@interface CartoTypePointSet: NSObject
    -(id)init:(CartoTypeCoordType)aCoordType;
    @property (nonatomic, readonly) CartoTypeCoordType coordType;
    -(void)append:(CartoTypePoint)aPoint;
    -(int)pointCount;
    -(CartoTypePoint)point:(int)aIndex;
    -(void*)pointVector;
@end
 
static const uint32_t KTimeValid = 1;
static const uint32_t KPositionValid = 2;
static const uint32_t KSpeedValid = 4;
static const uint32_t KCourseValid = 8;
static const uint32_t KHeightValid = 16;
 
typedef struct
    {
    uint32_t validity;
    double time;
    double longitude;
    double latitude;
    double speed;
    double course;
    double height;
    } CartoTypeNavigationData;
 
typedef enum
    {
    NoNavigationState,
    NoPositionNavigationState,
    TurnNavigationState,
    OffRouteNavigationState,
    RoutingNavigationState,
    NewRouteNavigationState,
    TurnRoundNavigationState,
    ArrivalNavigationState
    } CartoTypeNavigationState;
 
static const uint32_t KFollowFlagLocation = 1;
static const uint32_t KFollowFlagHeading = 2;
static const uint32_t KFollowFlagZoom = 4;
 
typedef enum
    {
    FollowModeNone = 0,
    FollowModeLocation = KFollowFlagLocation,
    FollowModeLocationHeading = KFollowFlagLocation | KFollowFlagHeading,
    FollowModeLocationZoom = KFollowFlagLocation | KFollowFlagZoom,
    FollowModeLocationHeadingZoom = KFollowFlagLocation | KFollowFlagHeading | KFollowFlagZoom
    } CartoTypeFollowMode;
 
typedef struct
    {
    int segmentIndex;
    int lineIndex;
    CartoTypePoint nearestPoint;
    double distanceToRoute;
    double distanceAlongRoute;
    double distanceAlongSegment;
    double timeAlongRoute;
    double timeAlongSegment;
    double heading;
    } CartoTypeNearestSegmentinfo;
 
@interface CartoTypeRouteSegment: NSObject <CartoTypePath>
    -(id)initWithRouteSegmentObject:(void*)aRouteSegmentObject;
    -(void)dealloc;
    -(CartoTypeFeatureInfo*)featureInfo;
    -(NSString*)name;
    -(NSString*)ref;
    -(double)distance;
    -(double)time;
    -(double)turnTime;
    -(CartoTypeTurnType)turnType;
    -(bool)isContinue;
    -(CartoTypeRoundaboutState)roundaboutState;
    -(double)turnAngle;
    -(int)exitNumber;
    -(int)choices;
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    -(int)section;
@end
 
@interface CartoTypeRoute: NSObject <CartoTypePath>
    -(id)initWithRouteObject:(void*)aRouteObject;
    -(void)dealloc;
    -(CartoTypeGeometry*)geometry;
    -(double)distance;
    -(double)tollRoadDistance;
    -(double)time;
    -(int)routeSegmentCount;
    -(CartoTypeRouteSegment*)routeSegmentByIndex:(int)aIndex;
    -(void)nearestSegment:(CartoTypePoint)aPoint info:(CartoTypeNearestSegmentinfo*)aInfo section:(int)aSection prevDistance:(double)aPreviousDistanceAlongRoute;
    -(void)pointAtDistance:(double)aDistanceInMeters info:(CartoTypeNearestSegmentinfo*)aInfo;
    -(void)pointAtTime:(double)aTimeInSeconds info:(CartoTypeNearestSegmentinfo*)aInfo;
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    -(void*)route;
@end
 
typedef struct
    {
    uint32_t vehicleTypes;
    double speed;
    } CartoTypeTrafficInfo;
 
typedef enum
    {
    RoadOrientationNone,
    RoadOrientationForwards,
    RoadOrientationBackwards,
    RoadOrientationBoth,
    } CartoTypeRoadOrientation;
 
typedef enum
    {
    LocationRefLine,
    LocationRefGeoCoordinate,
    LocationRefPointAlongLine,
    LocationRefPointWithAccessPoint,
    LocationRefCircle,
    LocationRefRectangle,
    LocationRefPolygon,
    LocationRefClosedLine
    } CartoTypeLocationRefType;
 
typedef struct
    {
    CartoTypeLocationRefType type;
    __unsafe_unretained NSString* identifier;
    __unsafe_unretained CartoTypeGeometry* geometry;
    double radiusInMeters;
    CartoTypeSideOfRoad sideOfRoad;
    CartoTypeRoadOrientation roadOrientation;
    } CartoTypeLocationRef;
 
@interface CartoTypeNavigatorParam: NSObject
    @property (nonatomic) int minimumFixDistance;
    @property (nonatomic) int routeDistanceTolerance;
    @property (nonatomic) int routeTimeTolerance;
    @property (nonatomic) bool navigationEnabled;
    -(void*)navigatorParam;
@end
 
@interface CartoTypeTimeAndDistanceMatrix: 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
 
 
#endif