CartoTypeRouter.h

Go to the documentation of this file.

/*
CartoTypeRouter.h
Copyright 2013-2022 CartoType Ltd.
See www.cartotype.com for more information.
*/
 
#ifndef CartoTypeRouter_h__
#define CartoTypeRouter_h__
 
static const uint32_t KArcAccessMask = 0x7FF00000;
static const uint32_t KArcWrongWayFlag = 0x00100000;
static const uint32_t KArcBicycleAccessFlag = 0x00200000;
static const uint32_t KArcMotorCycleAccessFlag = 0x00400000;
static const uint32_t KArcCarAccessFlag = 0x00800000;
static const uint32_t KArcHighOccupancyAccessFlag = 0x01000000;
static const uint32_t KArcLightGoodsAccessFlag = 0x02000000;
static const uint32_t KArcHeavyGoodsAccessFlag = 0x04000000;
static const uint32_t KArcBusAccessFlag = 0x08000000;
static const uint32_t KArcTaxiAccessFlag = 0x10000000;
static const uint32_t KArcPedestrianAccessFlag = 0x20000000;
static const uint32_t KArcEmergencyAccessFlag = 0x40000000;
static const uint32_t KArcOtherAccessFlag = 0x80000000;
static const uint32_t KArcBicycleAccessOnly = KArcAccessMask & ~(KArcWrongWayFlag | KArcBicycleAccessFlag);
static const uint32_t KArcAllMotorVehicles = KArcAccessMask & ~(KArcWrongWayFlag | KArcPedestrianAccessFlag | KArcBicycleAccessFlag);
static const uint32_t KArcNoVehicularAccess = KArcAccessMask & ~(KArcWrongWayFlag | KArcPedestrianAccessFlag);
static const uint32_t KArcAllVehicles = 0xFFE00000;
 
static const uint32_t KArcMotorway = 0;
static const uint32_t KArcMotorwayLink = 1;
static const uint32_t KArcTrunkRoad = 2;
static const uint32_t KArcTrunkRoadLink = 3;
static const uint32_t KArcPrimaryRoad = 4;
static const uint32_t KArcPrimaryRoadLink = 5;
static const uint32_t KArcSecondaryRoad = 6;
static const uint32_t KArcSecondaryRoadLink = 7;
static const uint32_t KArcTertiaryRoad = 8;
static const uint32_t KArcUnclassifiedRoad = 9;
static const uint32_t KArcResidentialRoad = 10;
static const uint32_t KArcTrack = 11;
static const uint32_t KArcServiceRoad = 12;
static const uint32_t KArcPedestrianRoad = 13;
static const uint32_t KArcVehicularFerry = 14;
static const uint32_t KArcPassengerFerry = 15;
static const uint32_t KArcLivingStreet = 16;
static const uint32_t KArcCycleway = 17;
static const uint32_t KArcPath = 18;
static const uint32_t KArcFootway = 19;
static const uint32_t KArcBridleway = 20;
static const uint32_t KArcSteps = 21;
static const uint32_t KArcUnknownRoadType = 22;
static const uint32_t KArcUnpavedRoad = 23;
static const uint32_t KArcOtherRoadType0 = 24;
static const uint32_t KArcOtherRoadType1 = 25;
static const uint32_t KArcOtherRoadType2 = 26;
static const uint32_t KArcOtherRoadType3 = 27;
static const uint32_t KArcOtherRoadType4 = 28;
static const uint32_t KArcOtherRoadType5 = 29;
static const uint32_t KArcOtherRoadType6 = 30;
static const uint32_t KArcOtherRoadType7 = 31;
static const uint32_t KArcRoadTypeCount = 32;
 
// Index values for use in the gradient arrays in CartoTypeRouteProfile
static const uint32_t KArcGradientUp0Index = 0;
static const uint32_t KArcGradientUp1Index = 1;
static const uint32_t KArcGradientUp2Index = 2;
static const uint32_t KArcGradientUp3Index = 3;
static const uint32_t KArcGradientDown0Index = 4;
static const uint32_t KArcGradientDown1Index = 5;
static const uint32_t KArcGradientDown2Index = 6;
static const uint32_t KArcGradientDown3Index = 7;
static const uint32_t KArcGradientCount = 8;
 
static const uint32_t KMaxRoutesDisplayed = 16;
 
typedef enum
    {
    CarProfile,
    WalkingProfile,
    BicycleProfile,
    HikingProfile
    } 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*)getProfile;
@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;
 
typedef enum
    {
    RoadRoutingMask = 0x3E,
    
    RoadTypeMask = 0xFC0,
    
    MajorRoadTypeMask = 0xF00,
    
    RoadLevelMask = 0xF000,
    
    TunnelRoadTypeFlag = 1,
    
    BridgeRoadTypeFlag = 0x10000,
    
    RoadLevelShift = 12,
    
    RampRoadTypeFlag = 64,
    
    LinkRoadTypeFlag = RampRoadTypeFlag,
    
    LowerGradeRoadTypeFlag = 128,
    
    UnknownMajorRoadType = 0,
    
    PrimaryLimitedAccessRoadType = 0x100,
    
    PrimaryUnlimitedAccessRoadType = 0x200,
    
    SecondaryRoadType = 0x300,
    
    MinorRoadType = 0x400,
    
    BywayRoadType = 0x500,
    
    AccessRampType = 0x600,
    
    ServiceRoadType = 0x700,
    
    VehicularFerryRoadType = 0x800,
    
    PassengerFerryRoadType = 0x900,
    
    PathRoadType = 0xA00,
    
    StairwayRoadType = 0xB00,
    
    CyclePathRoadType = 0xC00,
    
    FootPathRoadType = 0xD00,
    
    OtherRoadType0 = 0xE00,
    OtherRoadType1 = 0xE00 | LowerGradeRoadTypeFlag,
    OtherRoadType2 = 0xE00 | LinkRoadTypeFlag,
    OtherRoadType3 = 0xE00 | LowerGradeRoadTypeFlag | LinkRoadTypeFlag,
    OtherRoadType4 = 0xF00,
    OtherRoadType5 = 0xF00 | LowerGradeRoadTypeFlag,
    OtherRoadType6 = 0xF00 | LinkRoadTypeFlag,
    OtherRoadType7 = 0xF00 | LowerGradeRoadTypeFlag | LinkRoadTypeFlag,
    
    TollRoadTypeFlag = 2,
    
    RoundaboutRoadTypeFlag = 4,
    
    RestrictionRoadTypeFlag = 8,
    
    OneWayForwardRoadTypeFlag = 16,
    
    OneWayBackwardRoadTypeFlag = 32,
    
    FirstOverRoadLevel = 0x1000,
    
    FirstUnderRoadLevel = 0xF000,
    
    SecondUnderRoadLevel = 0xE000,
    
    RoadAccessMask = 0xFFFE0000,
    
    BicycleRoadAccessFlag = 0x20000,
    
    MotorCycleRoadAccessFlag = 0x40000,
    
    MotorCarRoadAccessFlag = 0x80000,
    
    HighOccupancyRoadAccessFlag = 0x100000,
    
    GoodsRoadAccessFlag = 0x200000,
    
    HeavyGoodsRoadAccessFlag = 0x400000,
    
    BusRoadAccessFlag = 0x800000,
    
    TaxiRoadAccessFlag = 0x1000000,
    
    PedestrianRoadAccessFlag = 0x2000000,
    
    AgriculturalRoadAccessFlag = 0x4000000,
    
    ForestryRoadAccessFlag = 0x8000000,
    
    EmergencyRoadAccessFlag = 0x10000000,
    
    HazardousRoadAccessFlag = 0x20000000,
    
    WheelChairRoadAccessFlag = 0x40000000,
    
    DisabledRoadAccessFlag = 0x80000000,
    
    MotorVehicleRoadAccessMask = 0xFFFE0000 & ~(BicycleRoadAccessFlag | WheelChairRoadAccessFlag),
    PublicServiceVehicleRoadAccessMask = BusRoadAccessFlag | TaxiRoadAccessFlag,
    
    // useful synonyms for road types
    Motorway = PrimaryLimitedAccessRoadType,
    MotorwayLink = PrimaryLimitedAccessRoadType | LinkRoadTypeFlag,
    TrunkRoad = PrimaryUnlimitedAccessRoadType,
    TrunkRoadLink = PrimaryUnlimitedAccessRoadType | LinkRoadTypeFlag,
    PrimaryRoad = PrimaryUnlimitedAccessRoadType | LowerGradeRoadTypeFlag,
    PrimaryRoadLink = PrimaryUnlimitedAccessRoadType | LowerGradeRoadTypeFlag | LinkRoadTypeFlag,
    SecondaryRoad = SecondaryRoadType,
    SecondaryRoadLink = SecondaryRoadType | LinkRoadTypeFlag,
    TertiaryRoad = SecondaryRoadType | LowerGradeRoadTypeFlag,
    TertiaryRoadLink = SecondaryRoadType | LowerGradeRoadTypeFlag | LinkRoadTypeFlag,
    UnclassifiedRoad = MinorRoadType,
    ResidentialRoad = MinorRoadType | LowerGradeRoadTypeFlag,
    Track = BywayRoadType,
    ServiceRoad = ServiceRoadType,
    PedestrianRoad = PathRoadType,
    VehicularFerry = VehicularFerryRoadType,
    PassengerFerry = PassengerFerryRoadType,
    }  CartoTypeRoadType;
 
@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) CartoTypeRoadType fromRoadType;
    @property (nonatomic, strong) NSString* toName;
    @property (nonatomic, strong) NSString* toRef;
    @property (nonatomic) CartoTypeRoadType toRoadType;
    @property (nonatomic) CartoTypePoint position;
    @property (nonatomic, strong) NSString* instructions;
@end
 
@interface CartoTypeNearestRoadInfo: NSObject
    @property (nonatomic) CartoTypeRoadType roadType;
    @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;
@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,
    ReRouteNeededNavigationState,
    ReRouteDoneNavigationState,
    TurnRoundNavigationState,
    ArrivalNavigationState
    } CartoTypeNavigationState;
 
static const uint32_t KFollowFlagLocation = 1;
static const uint32_t KFollowFlagHeading = 2;
/* A flag to set the map to a suitable zoom level for the user's speed. */
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 iSegmentIndex;
    int iLineIndex;
    CartoTypePoint iNearestPoint;
    double iDistanceToRoute;
    double iDistanceAlongRoute;
    double iDistanceAlongSegment;
    double iTimeAlongRoute;
    double iTimeAlongSegment;
    double iHeading;
    } CartoTypeNearestSegmentinfo;
 
@interface CartoTypeRouteSegment: NSObject <CartoTypePath>
    -(id)initWithRouteSegmentObject:(void*)aRouteSegmentObject;
    -(void)dealloc;
    -(CartoTypeRoadType)getRoadType;
    -(double)getMaxSpeed;
    -(NSString*)getName;
    -(NSString*)getRef;
    -(double)getDistance;
    -(double)getTime;
    -(double)getTurnTime;
    -(CartoTypeTurnType)getTurnType;
    -(bool)getContinue;
    -(CartoTypeRoundaboutState)getRoundaboutState;
    -(double)getTurnAngle;
    -(int)getExitNumber;
    -(int)getChoices;
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    -(int)getSection;
@end
 
@interface CartoTypeRoute: NSObject <CartoTypePath>
    -(id)initWithRouteObject:(void*)aRouteObject;
    -(void)dealloc;
    -(CartoTypeGeometry*)getGeometry;
    -(double)getDistance;
    -(double)getTollRoadDistance;
    -(double)getTime;
    -(int)getRouteSegmentCount;
    -(CartoTypeRouteSegment*)getRouteSegmentByIndex:(int)aIndex;
    -(void)getNearestSegment:(CartoTypePoint)aPoint info:(CartoTypeNearestSegmentinfo*)aInfo section:(int)aSection prevDistance:(double)aPreviousDistanceAlongRoute;
    -(void)getPointAtDistance:(double)aDistanceInMeters info:(CartoTypeNearestSegmentinfo*)aInfo;
    -(void)getPointAtTime:(double)aTimeInSeconds info:(CartoTypeNearestSegmentinfo*)aInfo;
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    -(void*)getRoute;
@end
 
typedef struct
    {
    uint32_t vehicleTypes;
    double speed;
    } CartoTypeTrafficInfo;
 
typedef enum
    {
    SideOfRoadNone,
    SideOfRoadRight,
    SideOfRoadLeft,
    SideOfRoadBoth
    } CartoTypeSideOfRoad;
 
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 autoReRoute;
    @property (nonatomic) bool navigationEnabled;
    -(void*)getNavigatorParam;
@end
 
typedef enum
    {
    RouteAccessUnknown,
    RouteAccessAccessible,
    RouteAccessIsolated,
    RouteAccessNoRoad
    } CartoTypeRouteAccess;
 
@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