QMSSearchOption.h

//
//  QMSSearchOption.h
//  QMapSearchKit
//
//  Created by xfang on 14/11/5.
//  Copyright (c) 2014年 tencent. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import <CoreLocation/CoreLocation.h>
#import <UIKit/UIKit.h>
#import "QMSSearchOptionTypes.h"
@interface QMSSearchOption : NSObject <NSCopying, NSCoding>
 
@property (nonatomic, copy) NSString *added_fields;
 
@property (nonatomic, copy) NSDictionary <NSString *, NSString *> *extraParam;
 
@end
 
#pragma mark -
 
@interface QMSPoiSearchOption : QMSSearchOption
 
@property (nonatomic, assign) NSUInteger page_size;
 
@property (nonatomic, assign) NSUInteger page_index;
 
@property (nonatomic, copy) NSString *keyword;
 
@property (nonatomic, copy) NSString *boundary;
 
- (void)setBoundaryByRegionWithCityName: (NSString *)cityName autoExtend:(BOOL)isAutoEntend;
 
- (void)setBoundaryByRegionWithCityName: (NSString *)cityName autoExtend:(BOOL)isAutoEntend center:(CLLocationCoordinate2D)coordinate;
 
- (void)setBoundaryByNearbyWithCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate radius:(NSUInteger)radius autoExtend:(BOOL)isAutoEntend;
 
- (void)setBoundaryByRectangleWithleftBottomCoordinate:(CLLocationCoordinate2D)leftBottomCoordinate rightTopCoordinate:(CLLocationCoordinate2D)rightTopCoordinate;
 
@property (nonatomic, copy) NSString *filter;
 
- (void)setFilterByCategories:(NSArray<NSString *> *)categories;
 
@property (nonatomic, copy) NSString *orderby;
 
@property (nonatomic, copy) NSNumber *get_subpois;
 
@property (nonatomic, copy) NSNumber *sub_title_format;
 
@end
 
 
@interface QMSPoiExploreSearchOption : QMSSearchOption
 
@property (nonatomic, assign) NSUInteger page_size;
 
@property (nonatomic, assign) NSUInteger page_index;
 
 
@property (nonatomic, copy) NSString *boundary;
 
- (void)setBoundaryByNearbyWithCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate radius:(NSUInteger)radius autoExtend:(BOOL)isAutoEntend;
 
@property (nonatomic, assign) int policy;
 
@property (nonatomic, copy) NSString *filter;
 
- (void)setFilterByCategories:(NSArray<NSString *> *)categories;
 
@property (nonatomic, copy) NSString *orderby;
 
@property (nonatomic, copy) NSString *address_format;
 
@end
 
@interface QMSPoiDetailSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *ID;
 
@end
 
#pragma mark -
 
@interface QMSSuggestionSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *keyword;
 
@property (nonatomic, copy) NSString *region;
 
@property (nonatomic, copy) NSString *filter;
 
- (void)setFilterByCategories:(NSArray<NSString *> *)categories;
 
@property (nonatomic, copy) NSNumber *region_fix;
 
@property (nonatomic, copy) NSString *location;
 
- (void)setLocationWithCoordinate:(CLLocationCoordinate2D)coordinate;
 
 
@property (nonatomic, copy) NSNumber *get_subpois;
 
@property (nonatomic, copy) NSNumber *policy;
 
@property (nonatomic, copy) NSString *address_format;
 
@property (nonatomic, copy) NSNumber *page_index;
 
@property (nonatomic, copy) NSNumber *page_size;
 
@end
 
#pragma mark -
 
@interface QMSReverseGeoCodeSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *location;
 
- (void)setLocationWithCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate;
 
@property (nonatomic, copy) NSString *poi_options;
 
@property (nonatomic, assign) BOOL get_poi;
 
@property (nonatomic, assign) QMSStreetNumberFormat street_number_format;
 
@end
 
#pragma mark -
 
@interface QMSGeoCodeSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *address;
 
@property (nonatomic, copy) NSString *region;
 
@end
 
#pragma mark - 
 
@interface QMSWalkingRouteSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *from;
 
- (void)setFromCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *from_poi;
 
@property (nonatomic, copy) NSString *to;
 
- (void)setToCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *to_poi;
 
@end
 
#pragma mark -
 
@interface QMSBicyclingRouteSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *from;
 
- (void)setFromCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *from_poi;
 
@property (nonatomic, copy) NSString *to;
 
- (void)setToCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *to_poi;
 
@end
 
#pragma mark -
 
@interface QMSTrackPoint : QMSSearchOption
 
@property (nonatomic, assign) CLLocationCoordinate2D    coordinate;
 
@property (nonatomic, assign) double    speed;
 
@property (nonatomic, assign) double    accuracy;
 
@property (nonatomic, assign) double    course;
 
@property (nonatomic, assign) double    heading;
 
@property (nonatomic, assign) double    time;
 
@end
 
@interface QMSUniveralPolygon : NSObject
 
@property (nonatomic, assign) CLLocationCoordinate2D *coordinates;
 
@property (nonatomic, assign) NSUInteger count;
 
@end
 
typedef enum
{
    QMSDrivingRoutePolicyTypeLeastTime = 0,     //省时
    QMSDrivingRoutePolicyTypeLeastFee = 1,      //省钱
    QMSDrivingRoutePolicyTypeLeastDistance = 2, //距离最短
    QMSDrivingRoutePolicyTypeRealTraffic = 3,   //综合最优
} QMSDrivingRoutePolicyType;
 
// 策略
typedef NS_ENUM(NSInteger, QMSDrivingRoutePolicyTypeNew) {
    // 参考实时路况，时间最短. 默认值.
    QMSDrivingRoutePolicyTypeNewLeastTime,
    // 网约车场景 - 接乘客
    QMSDrivingRoutePolicyTypeNewPickup,
    // 网约车场景 – 送乘客
    QMSDrivingRoutePolicyTypeNewTrip,
};
 
// 偏好参数. 多个偏好可并用。
typedef NS_OPTIONS(NSUInteger, QMSDrivingRoutePerference) {
    // 无偏好 （默认）
    QMSDrivingRoutePerferenceNone               = 0,
    // 参考实时路况
    QMSDrivingRoutePerferenceRealTraffic        = 1 << 0,
    // 少收费
    QMSDrivingRoutePerferenceLeastFee           = 1 << 1,
    // 高速优先
    QMSDrivingRoutePerferenceHighwayFirst       = 1 << 2,
    // 不走高速
    QMSDrivingRoutePerferenceAvoidHighway       = 1 << 3,
    // 大路优先
    QMSDrivingRoutePerferenceHighroadFirst      = 1 << 4,
    // 该策略会通过终点坐标查找所在地点（如小区/大厦等），并使用地点出入口做为目的地，使路径更为合理
    QMSDrivingRoutePerferenceNavPointFirst      = 1 << 5
};
 
@interface QMSDrivingRouteSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *from;
 
- (void)setFromCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *from_poi;
 
@property (nonatomic, copy) NSString *from_track;
 
- (void)setTrackPoints:(NSArray<QMSTrackPoint *> *)points;
 
@property (nonatomic, copy) NSString *to;
 
- (void)setToCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *to_poi;
 
@property (nonatomic, copy) NSString *policy;
 
- (void)setPolicyWithType:(QMSDrivingRoutePolicyType)type __attribute__ ((deprecated("use @property (nonatomic, assign) QMSDrivingRoutePolicyTypeNew policyType; and @property (nonatomic, assign) QMSDrivingRoutePerference perference; instead")));
 
@property (nonatomic, assign) QMSDrivingRoutePolicyTypeNew policyType;
 
@property (nonatomic, assign) QMSDrivingRoutePerference perference;
 
@property (nonatomic, assign) QMSRouteTagType   tag_mode;
 
@property (nonatomic, copy) NSString *waypoints;
 
- (void)setWayPointsWithCoordinates:(CLLocationCoordinate2D *)coordinates count:(NSUInteger)count;
 
@property (nonatomic, copy) NSString *avoid_polygons;
 
- (void)setAvoidPolygon:(NSArray<QMSUniveralPolygon *> *)avoidPolygons;
 
@property (nonatomic, copy) NSNumber    *heading;
 
@property (nonatomic, copy) NSNumber    *speed;
 
@property (nonatomic, copy) NSNumber    *accuracy;
 
@property (nonatomic, copy) NSString *plate_number;
 
@property (nonatomic, assign) int get_mp;
 
@property (nonatomic, assign) int no_step;
 
@property (nonatomic, assign) int cartype;
 
@property (nonatomic, assign) int get_speed;
 
@property (nonatomic, copy) NSDate *departure_time;
 
@end
 
#pragma mark - TruckingRoute
 
@interface QMSTruckingRouteSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *from;
 
- (void)setFromCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *from_poi;
 
@property (nonatomic, copy) NSString *to;
 
- (void)setToCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *to_poi;
 
@property (nonatomic) NSInteger size;
 
@property (nonatomic) float length;
 
@property (nonatomic) float height;
 
@property (nonatomic) float width;
 
@property (nonatomic) float weight;
 
@property (nonatomic) float axle_weight;
 
@property (nonatomic) float axle_count;
 
@property (nonatomic) NSInteger is_trailer;
 
@property (nonatomic, copy) NSString *waypoints;
 
- (void)setWayPointsWithCoordinates:(CLLocationCoordinate2D *)coordinates count:(NSUInteger)count;
 
@property (nonatomic) NSInteger policy;
 
@property (nonatomic, copy) NSString *plate_number;
 
@property (nonatomic) NSInteger plate_color;
 
@property (nonatomic) NSInteger get_speed;
 
@property (nonatomic) NSInteger get_mp;
 
@property (nonatomic) NSInteger no_step;
 
@property (nonatomic) NSInteger no_polyline;
 
@property (nonatomic,assign) CGFloat load;
 
@property (nonatomic, assign) QMSTruckTrailerType   trailer_type;
 
@property (nonatomic, assign) QMSTruckGoodsType goods_type;
 
@property (nonatomic, assign) QMSVehicleEnergyType  energy_type;
 
@property (nonatomic, assign) QMSVehicleGasEmisStandard gas_emisstand;
 
@property (nonatomic, assign) QMSVehiclePassType    pass_type;
 
@property (nonatomic, assign) QMSRouteTagType   tag_mode;
 
@end
 
#pragma mark - BusingRoute
 
typedef enum
{
    QMSBusingRoutePolicyTypeLeastTime = 0,          //省时
    QMSBusingRoutePolicyTypeLeastTransfer = 1,      //少换乘
    QMSBusingRoutePolicyTypeLeastWalking = 2,       //少步行
} QMSBusingRoutePolicyType;
 
@interface QMSBusingRouteSearchOption : QMSSearchOption
 
@property (nonatomic, copy) NSString *from;
 
- (void)setFromCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *to;
 
- (void)setToCoordinate:(CLLocationCoordinate2D)coordinate;
 
@property (nonatomic, copy) NSString *policy;
 
- (void)setPolicyWithType:(QMSBusingRoutePolicyType)type;
 
@property (nonatomic, copy) NSDate *departure_time;
 
@end
 
#pragma mark - QMSDistrictListSearchOption
 
typedef enum
{
    QMSDistrictPolygonWithoutResult = 0,    /// 默认，不返回轮廓
    QMSDistrictPolygonWithSeaArea   = 1,    /// 包含海域，3公里抽稀粒度
    QMSDistrictPolygonWithLandOnly  = 2     /// 纯陆地行政区划，可通过max_offset设置返回轮廓的抽稀级别
    
}QMSDistrictPolygonOption;
 
@interface QMSDistrictBaseSearchOption : QMSSearchOption
 
@property (nonatomic, assign) QMSDistrictPolygonOption get_polygon;
 
@property (nonatomic, assign) int max_offset;
 
@end
 
@interface QMSDistrictListSearchOption : QMSDistrictBaseSearchOption
 
@end
 
#pragma mark - QMSDistrictChildrenSearchOption
 
@interface QMSDistrictChildrenSearchOption : QMSDistrictBaseSearchOption
 
@property (nonatomic, copy) NSString *ID;
 
@end
 
#pragma mark - QMSDistrictSearchSearchOption
 
@interface QMSDistrictSearchSearchOption : QMSDistrictBaseSearchOption
 
@property (nonatomic, copy) NSString *keyword;
 
@end