TNKDriveCommonObj.h

Go to the documentation of this file.

//
//  TNKDriveCommonObj.h
//  TencentNavKit
//
//  Created by mol on 2022/7/26.
//  Copyright © 2022 Tencent. All rights reserved.
//
 
#import <TencentNavKit/TNKCommonObj.h>
#import <TencentNavKit/TNKDriveRouteExplain.h>
#import <TencentNavKit/TNKRouteTrafficItem.h>
#import <TencentNavKit/TNKSegmentItem.h>
#import <TencentNavKit/TNKLocation.h>
 
NS_ASSUME_NONNULL_BEGIN
 
@class TNKTruckSearchOption;
@class TNKForkPoint;
@class TNKNavToWayPointInfo;
@class TencentLBSLocation;
@class TNKTruckRestrictionItem;
@class TNKTurnRestrictionItem;
@class TNKCustomRouteReason;
 
extern NSString * const TNKDriveRouteSearchErrorDomain;
 
typedef enum _TNKDriveRouteSearchErrorCode
{
    TNKDriveRouteSearchErrorCode_NetworkError                 = 1001,     
    TNKDriveRouteSearchErrorCode_NoNetwork                    = 1002,     
    TNKDriveRouteSearchErrorCode_RequestTimeOut               = 1003,     
    TNKDriveRouteSearchErrorCode_DataInvalid                  = 2001,     
    TNKDriveRouteSearchErrorCode_StartDestPointError          = 2002,     
    TNKDriveRouteSearchErrorCode_WayPointError                = 2003,     
    TNKDriveRouteSearchErrorCode_AdsorptionFailed             = 2004,     
    TNKDriveRouteSearchErrorCode_CalculateFailed              = 2005,     
    TNKDriveRouteSearchErrorCode_InvalidKeyError              = 2006,     
    TNKDriveRouteSearchErrorCode_NavigationParaInvalid        = 2007,     
    TNKDriveRouteSearchErrorCode_ChangeRouteByRouteIDFailed   = 2008,     
    TNKDriveRouteSearchErrorCode_Privacy_Failed               = 2009,     
    TNKDriveRouteSearchErrorCode_ServerError                  = 2999      
} TNKDriveRouteSearchErrorCode;                           
 
typedef enum _TNKRoadType
{
    TNKRoadType_None                   = 0,        
    TNKRoadType_Elevated               = 1,        
    TNKRoadType_Downstairs             = 2,        
    TNKRoadType_MainRoad               = 3,        
    TNKRoadType_ServingRoad            = 4,        
    TNKRoadType_DirectionRoad          = 5,        
    TNKRoadType_DownstairsMainRoad     = 6,        
    TNKRoadType_DownstairsServingRoad  = 7,        
} TNKRoadType;         
 
typedef enum _TNKCameraType
{
    TNKCameraTypeNone                 = 0,  
    TNKCameraTypeRedLight             = 1,  
    TNKCameraTypeElectronicMonitoring = 2,  
    TNKCameraTypeFixedSpeedTraps      = 3,  
    TNKCameraTypeMobileSpeedZone      = 4,  
    TNKCameraTypeBusOnlyWay           = 5,  
    TNKCameraTypeOneWay               = 6,  
    TNKCameraTypeEmergencyWay         = 7,  
    TNKCameraTypeNoneMotorWay         = 8,  
    TNKCameraTypeQujianEnter          = 9,  
    TNKCameraTypeQujianExit           = 10, 
    TNKCameraTypeHOV                  = 16, 
    TNKCameraTypeLaLian               = 17, 
    TNKCameraTypeTailNumber           = 21, 
    TNKCameraTypeGoToBeijing          = 22, 
    TNKCameraTypeIllegalBlow          = 23, 
    TNKCameraTypeBusStation           = 24, 
    TNKCameraTypeForbiddenTure        = 30, 
    TNKCameraTypeForbiddenLine        = 31, 
    TNKCameraTypeForbiddenParking     = 32, 
    TNKCameraTypeLowestSpeed          = 33, 
    TNKCameraTypeAlterableSpeed       = 34, 
    TNKCameraTypeLaneSpeed            = 35, 
    TNKCameraTypeVehicelTypeSpeed     = 36, 
    TNKCameraTypeLaneOccupy           = 37, 
    TNKCameraTypeCrossing             = 38, 
    TNKCameraTypeForbiddenSign        = 39, 
    TNKCameraTypeForbiddenLight       = 40, 
    TNKCameraTypeLifeBelt             = 41, 
    TNKCameraTypeForbiddenCall        = 42, 
    TNKCameraTypeLimitLine            = 43, 
    TNKCameraTypePedestrainFirst      = 44, 
    TNKCameraTypeAnnualInpection      = 45, 
    TNKCameraTypeVehicelExhaust       = 46, 
    TNKCameraTypeTraffic              = 47, 
    TNKCameraTypeEntrance             = 48, 
    TNKCameraTypeForbiddenUTurn       = 49, 
    TNKCameraTypeEtcToll              = 50, 
    TNKCameraTypeNotFollowGuideLane   = 51, 
    TNKCameraTypeTrafficFlowMonitor   = 52, 
    TNKCameraTypeKeepSafeDistance     = 53, 
    TNKCameraTypeIllegalChangeLane    = 54  
} TNKCameraType; 
 
 
typedef enum _TNKTurnRestrictionType
{
    TNKTurnRestrictionTypeNone = 0,         
    TNKTurnRestrictionTypeLeft = 1,         
    TNKTurnRestrictionTypeRight = 2,        
    TNKTurnRestrictionTypeLeftUTurn = 3,    
    TNKTurnRestrictionTypeRightUTurn = 4,   
    TNKTurnRestrictionTypeStraight = 5,     
} TNKTurnRestrictionType; 
 
 
typedef enum _TNKTrafficLightType
{
    TNKTrafficLightTypeNone = -1,   
    TNKTrafficLightTypeRed = 0,     
    TNKTrafficLightTypeGreen = 1,   
    TNKTrafficLightTypeYellow = 2,  
} TNKTrafficLightType; 
 
typedef NS_OPTIONS(NSUInteger, TNKDriveLimitStatus) {
    TNKDriveLimitStatusNone             = 0,            
    TNKDriveLimitStatusAvoided          = 1 << 0,       
    TNKDriveLimitStatusLimitAtStart     = 1 << 1,       
    TNKDriveLimitStatusLimitAtEnd       = 1 << 2,       
    TNKDriveLimitStatusThrough          = 1 << 3,       
    TNKDriveLimitStatusCanAvoid         = 1 << 4,       
};
 
typedef enum _TNKSliceType
{
    TNKSliceTypeNone    = 0,        
    TNKSliceTypeTwo     = 1,        
    TNKSliceTypeThree   = 2,        
    TNKSliceTypeAuto    = 9,        
} TNKSliceType;         
 
 
/*------------------------------------导航过程------------------------------------*/
 
@interface TNKNavStartFailInfo : NSObject
 
@property (nonatomic, assign) int code;
 
@property (nonatomic, copy) NSString *msg;
 
@property (nonatomic, copy) NSString *routeID;
 
@end
typedef enum _TNKRoadMatchStatus
{
    TNKRoadMatchStatusNull = -1,            
    TNKRoadMatchStatusOffRoute = 0,         
    TNKRoadMatchStatusOnRoute = 1,          
} TNKRoadMatchStatus;   
 
 
 
@interface TNKDriveRouteSearchOption : NSObject<NSCopying>
 
@property (nonatomic, assign) BOOL avoidToll;
 
@property (nonatomic, assign) BOOL avoidHighway;
 
@property (nonatomic, assign) BOOL avoidTrafficJam;
 
@property (nonatomic, assign) BOOL highway;
 
@property (nonatomic, assign) BOOL shortTime;
 
@property (nonatomic, assign) BOOL isShortDistance;
 
@property (nonatomic, assign) BOOL bigRoad;
 
@property (nonatomic, assign) TNKRoadType startRoadType;
    
@property (nonatomic, copy, nullable) NSString *carNumber;
 
@property (nonatomic, assign) BOOL greenCar;
 
@property (nonatomic, assign) BOOL searchMultiRoutes;
 
@property (nonatomic, copy, nullable) NSArray<TencentLBSLocation *> *preLocations;
 
@property (nonatomic, copy, nullable) NSArray<TencentLBSLocation *> *routePointsLocations;
 
@property (nonatomic, assign) BOOL routePointsIsSearch;
 
@property (nonatomic, assign) BOOL routePointsIsReRouteSearch;
 
@property (nonatomic, assign) BOOL avoidLimit;
 
@property (nonatomic, assign) TNKSliceType sliceType;
 
 
/*------------------------------------货车导航参数------------------------------------*/
 
@property (nonatomic, copy, nullable) TNKTruckSearchOption *truckSearchOption;
 
 
/*------------------------------------出行场景参数------------------------------------*/
 
@property (nonatomic, assign) int navScene;
 
@property (nonatomic, copy, nullable) NSString *userID;
 
@property (nonatomic, copy, nullable) NSString *initialRouteID;
 
@property (nonatomic, copy, nullable) NSString *initialRequestID;
 
@end
 
@interface TNKDriveRouteRequest: TNKRouteRequest
 
@property (nonatomic, copy, nullable) NSArray<TNKSearchNavPoint *> *waypoints;
 
@property (nonatomic, copy) TNKDriveRouteSearchOption *searchOption;
 
- (int)setAvoidAreas:(NSArray<NSArray<TNKCoordinatePoint *> *> *)avoidAreas;
 
@end
 
@interface TNKDriveRoute : NSObject
 
@property (nonatomic, readonly) NSString *recommendReason;
 
@property (nonatomic, readonly) NSArray<TNKCoordinatePoint *> *routePoints;
 
@property (nonatomic, readonly) NSString *routeID;
 
@property (nonatomic, readonly) int totalDistance;
 
@property (nonatomic, readonly) int totalTime;
 
@property (nonatomic, readonly) int trafficLightCount;
 
@property (nonatomic, readonly) int fee;
 
@property (nonatomic, readonly) int tollDistance;
 
@property (nonatomic, readonly) TNKSearchNavPoint *origin;
 
@property (nonatomic, readonly) TNKSearchNavPoint *destination;
 
@property (nonatomic, readonly, nullable) NSArray<TNKNavToWayPointInfo *> *waypoints;
 
@property (nonatomic, readonly) NSArray <TNKRouteTrafficItem *> *routeTrafficItems;
 
@property (nonatomic, readonly) NSArray <TNKSegmentItem *> *segmentItems;
 
@property (nonatomic, readonly, nullable) NSArray <TNKDriveRouteExplain *> *routeExplainItems;
 
@property (nonatomic, readonly, nullable) NSArray <TNKRoutePoint *> *trafficLights;
 
@property (nonatomic, readonly, nullable) NSArray<TNKForkPoint *> *forkPoints;
 
@property (nonatomic, readonly) int bkRecommendType;
 
@property (nonatomic, readonly) NSArray<TNKTurnRestrictionItem *> *turnRestrictionItems;
 
@property (nonatomic, readonly) NSArray<TNKTruckRestrictionItem *> *truckRestrictionItems;
 
@property (nonatomic, readonly, nullable) NSArray<NSNumber *> *customTags;
 
@property (nonatomic, readonly) TNKDriveLimitStatus limitStatus;
 
@property (nonatomic, readonly) NSString *experienceRouteID;
 
@end
 
@interface TNKDriveRouteSearchResult : NSObject
 
@property (nonatomic, readonly) NSArray<TNKDriveRoute *> *routes;
 
@property (nonatomic, readonly) BOOL isSearchByRouteIDWorking;
 
@property (nonatomic, readonly) BOOL hitEndAdsorbExtStrategy;
 
@property (nonatomic, readonly) NSString *naviSessionID;
 
 
@property (nonatomic, readonly, nullable) TNKCustomRouteReason *customRouteReason;
 
@end
 
 
typedef enum _TNKTruckType
{
    TNKTruckTypeMiniTruck                 = 1,                  
    TNKTruckTypeLightTruck                = 2,                  
    TNKTruckTypeMediumTruck               = 3,                  
    TNKTruckTypeHeavyTruck                = 4,                  
} TNKTruckType;     
 
 
typedef enum _TNKTruckTrailerType
{
    TNKTruckTrailerTypeUnknown = 0, 
    TNKTruckTrailerTypeFlatbed,     
    TNKTruckTrailerTypeContainer,   
    TNKTruckTrailerTypeSemi,        
    TNKTruckTrailerTypeFull,        
} TNKTruckTrailerType; 
 
typedef enum _TNKTruckPlateColor
{
    TNKTruckPlateColorUnknown = 0,  
    TNKTruckPlateColorBlue,         
    TNKTruckPlateColorYellow,       
    TNKTruckPlateColorBlack,        
    TNKTruckPlateColorWhite,        
    TNKTruckPlateColorGreen,        
    TNKTruckPlateColorYellowGreen,  
} TNKTruckPlateColor; 
 
typedef enum _TNKEnergyType
{
    TNKEnergyTypeUnknown = 0,       
    TNKEnergyTypeDiesel,            
    TNKEnergyTypeHybird,            
    TNKEnergyTypeElectric,          
    TNKEnergyTypeGas,               
} TNKEnergyType; 
 
typedef enum _TNKTruckFunctionType
{
    TNKTruckFunctionTypeNormal = 0,         
    TNKTruckFunctionTypeDanger,             
} TNKTruckFunctionType; 
 
typedef enum _TNKEmissionStandard
{
    TNKEmissionStandardUnknown = 0,         
    TNKEmissionStandardI,                   
    TNKEmissionStandardII,                  
    TNKEmissionStandardIII,                 
    TNKEmissionStandardIV,                  
    TNKEmissionStandardV,                   
    TNKEmissionStandardVI,                  
} TNKEmissionStandard; 
 
typedef enum _TNKTruckPassType
{
    TNKTruckPassTypeNoNeed,             
    TNKTruckPassTypeHave,               
    TNKTruckPassTypeNotHave,            
    TNKTruckPassTypeApproval,           
} TNKTruckPassType; 
 
 
typedef enum _TNKTruckRestrictionType
{
    TNKTruckRestrictionTypeNone   = 0,     
    TNKTruckRestrictionTypeWidth  = 1,     
    TNKTruckRestrictionTypeHeight = 2,     
    TNKTruckRestrictionTypeLength = 3,     
    TNKTruckRestrictionTypeWeight = 4,     
    TNKTruckRestrictionTypeDanger = 5,     
} TNKTruckRestrictionType;     
 
@interface TNKTruckSearchOption : NSObject<NSCopying>
 
@property (nonatomic, assign) TNKTruckType truckType;
 
@property (nonatomic, assign) float length;
 
@property (nonatomic, assign) float width;
 
@property (nonatomic, assign) float height;
 
@property (nonatomic, assign) float weight;
 
@property (nonatomic, assign) float load;
 
@property (nonatomic, assign) int axisCount;
 
@property (nonatomic, assign) float axisLoad;
 
@property (nonatomic, assign) TNKTruckTrailerType trailerType;
 
@property (nonatomic, assign) TNKTruckPlateColor plateColor;
 
@property (nonatomic, assign) TNKEnergyType energyType;
 
@property (nonatomic, assign) TNKTruckFunctionType functionType;
 
@property (nonatomic, assign) TNKEmissionStandard emissionStandard;
 
@property (nonatomic, assign) TNKTruckPassType passType;
 
@property (nonatomic, assign) BOOL willIgnoreWeight;
 
 
@property (nonatomic, assign) BOOL needExperienceRoute;
 
@end
 
@interface TNKForkPoint : NSObject
 
@property (nonatomic, readonly) CLLocationCoordinate2D coord;
@property (nonatomic, readonly) int pointIndex;
@property (nonatomic, readonly) NSString *forkRouteID;
 
@end
 
 
@interface TNKDriveNavRoute : NSObject
 
- (instancetype)init NS_UNAVAILABLE;
 
- (instancetype)initWithSearchRoute:(TNKDriveRoute *)searchRoute;
 
@property (nonatomic, readonly) TNKDriveRoute *searchRoute;
 
@property (nonatomic, readonly) int remainingDistance;
 
@property (nonatomic, readonly) int remainingTime;
 
@property (nonatomic, readonly) int remainingTimeInSeconds;
 
@property (nonatomic, readonly) NSArray<TNKRouteTrafficItem *> *curTrafficItems;
 
@property (nonatomic, readonly, nullable) TNKLocation *location;
 
@property (nonatomic, readonly) int distBetweenOrginAndRouteFistPoint;
 
@end
 
@interface TNKNavCameraInfo : NSObject
 
@property (nonatomic, assign) TNKCameraType type;
 
@property (nonatomic, strong) TNKRoutePoint *routePoint;
 
@property (nonatomic, assign) int distance;
 
@property (nonatomic, assign) int limitSpeed;
 
@property (nonatomic, assign) int speedZoneLimitLength;
 
@end
 
@interface TNKRestrictionItem : NSObject
 
@property (nonatomic, readonly) TNKRoutePoint *routePoint;
 
@property (nonatomic, readonly) NSString *roadName;
 
@end
 
@interface TNKTruckRestrictionItem : TNKRestrictionItem
 
@property (nonatomic, readonly) TNKTruckRestrictionType type;
 
@property (nonatomic, readonly) float limitWidth;
 
@property (nonatomic, readonly) float limitHeight;
 
@property (nonatomic, readonly) float limitLength;
 
@property (nonatomic, readonly) float limitWeight;
 
@end
 
@interface TNKTurnRestrictionItem : TNKRestrictionItem
 
@property (nonatomic, readonly) TNKTurnRestrictionType type;
 
@property (nonatomic, readonly) BOOL always;
 
@property (nonatomic, readonly) NSString *timeDesc;
 
@property (nonatomic, readonly) int limitCarType;
 
@end
 
@interface TNKNavRestrictionItem : NSObject
 
@property (nonatomic, strong, readonly) TNKRestrictionItem *restrictionItem;
 
@property (nonatomic, readonly) int distance;
 
@end
 
@interface TNKTruckNavRestrictionItem : TNKNavRestrictionItem
 
@property (nonatomic, strong, readonly) TNKTruckRestrictionItem *truckRestrictionItem;
 
@end
 
@interface TNKTurnNavRestrictionItem : TNKNavRestrictionItem
 
@property (nonatomic, strong, readonly) TNKTurnRestrictionItem *turnRestrictionItem;
 
@end
 
@interface TNKNavRestrictionInfo : NSObject
 
@property (nonatomic, readonly) NSArray<TNKTruckNavRestrictionItem *> *truckNavRestrictionItems;
 
@property (nonatomic, readonly) NSArray<TNKTurnNavRestrictionItem *> *turnNavRestrictionItems;
 
@end
 
 
@interface TNKRouteFilterLink : NSObject
 
@property (nonatomic, readonly) NSString *linkID;
 
@property (nonatomic, readonly) int  filterType;
 
@property (nonatomic, readonly) CLLocationCoordinate2D coord;
 
@end
 
 
@interface TNKCustomRouteReason : NSObject
 
@property (nonatomic, readonly) NSArray<TNKRouteFilterLink *> *filterLinks;
 
@property (nonatomic, readonly) int customerState;
 
@end
 
@interface TNKTrafficLightCountdownMsg : NSObject
 
@property (nonatomic, readonly) TNKRoutePoint *routePoint;
@property (nonatomic, readonly) TNKTrafficLightType trafficLightType;
@property (nonatomic, readonly) int endTimestamp;
@property (nonatomic, readonly) TNKTrafficLightType nextTrafficLightType;
@property (nonatomic, readonly) int nextEndTimestamp;
 
@end
 
 
@interface TNKNavRoadMatchResult : NSObject
 
@property (nonatomic, readonly) TNKRoadMatchStatus roadMatchStatus;
 
@property (nonatomic, readonly) CLLocation *mactchLocation;
 
@property (nonatomic, readonly) TNKRoadGrade roadGrade;
 
@property (nonatomic, readonly) TNKRoadKind roadKind;
 
@property (nonatomic, readonly) double roadDir;
 
@end
 
@interface TNKPosMatchLocation: NSObject
 
@property (nonatomic, readonly) TencentLBSLocation *origLocation;
 
@property (nonatomic, readonly) TNKNavRoadMatchResult *roadMatchResult;
 
 
@end
 
 
NS_ASSUME_NONNULL_END