AMapCommonObj.h

Go to the documentation of this file.

//
//  AMapCommonObj.h
//  AMapSearchKit
//
//  Created by xiaoming han on 15/7/22.
//  Copyright (c) 2015年 Amap. All rights reserved.
//
 
/* 该文件定义了搜索结果的基础数据类型。*/
 
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
 
#pragma mark - AMapSearchObject
 
@interface AMapSearchObject : NSObject<NSCopying, NSCoding>
 
- (NSString *)formattedDescription;
 
@end
 
#pragma mark - 通用数据结构
 
@interface AMapGeoPoint : AMapSearchObject
@property (nonatomic, assign) CGFloat latitude;
@property (nonatomic, assign) CGFloat longitude;
 
+ (AMapGeoPoint *)locationWithLatitude:(CGFloat)lat longitude:(CGFloat)lon;
@end
 
@interface AMapGeoPolygon : AMapSearchObject
@property (nonatomic, strong) NSArray<AMapGeoPoint *> *points;
 
+ (AMapGeoPolygon *)polygonWithPoints:(NSArray *)points;
@end
 
@class AMapDistrict;
@interface AMapCity : AMapSearchObject
@property (nonatomic, copy) NSString  *city;
@property (nonatomic, copy) NSString  *citycode;
@property (nonatomic, copy) NSString  *adcode;
@property (nonatomic, assign) NSInteger  num;
@property (nonatomic, strong) NSArray<AMapDistrict *> *districts;
@end
 
@interface AMapSuggestion : AMapSearchObject
@property (nonatomic, strong) NSArray<NSString *> *keywords;
@property (nonatomic, strong) NSArray<AMapCity *> *cities;
@end
 
#pragma mark - 输入提示
 
@interface AMapTip : AMapSearchObject
@property (nonatomic, copy) NSString *uid;
@property (nonatomic, copy) NSString *name;
@property (nonatomic, copy) NSString *adcode;
@property (nonatomic, copy) NSString *district;
@property (nonatomic, copy) NSString *address;
@property (nonatomic, copy) AMapGeoPoint *location;
@property (nonatomic, copy) NSString *typecode;
@end
 
#pragma mark - POI
 
@interface AMapImage : AMapSearchObject
@property (nonatomic, copy) NSString *title;
@property (nonatomic, copy) NSString *url;
@end
 
@interface AMapPOIExtension : AMapSearchObject
@property (nonatomic, assign) CGFloat  rating;
@property (nonatomic, assign) CGFloat  cost;
@property (nonatomic, copy)   NSString *openTime;
@end
 
@interface AMapIndoorData : AMapSearchObject
@property (nonatomic, assign) NSInteger indoorMap;
@property (nonatomic, assign) NSInteger floor;
@property (nonatomic, copy)   NSString  *floorName;
@property (nonatomic, copy)   NSString  *pid;
@end
 
@interface AMapBusinessData : AMapSearchObject
@property (nonatomic, copy)   NSString *businessArea;
@property (nonatomic, copy)   NSString *opentimeToday;
@property (nonatomic, copy)   NSString *opentimeWeek;
@property (nonatomic, copy)   NSString  *tel;
@property (nonatomic, copy)   NSString  *tag;
@property (nonatomic, copy)   NSString  *rating;
@property (nonatomic, copy)   NSString  *cost;
@property (nonatomic, copy)   NSString  *parkingType;
@property (nonatomic, copy)   NSString  *alias;
@end
 
@interface AMapSubPOI : AMapSearchObject
@property (nonatomic, copy)   NSString     *uid;
@property (nonatomic, copy)   NSString     *name;
@property (nonatomic, copy)   NSString     *sname;
@property (nonatomic, copy)   AMapGeoPoint *location;
@property (nonatomic, copy)   NSString     *address;
@property (nonatomic, assign) NSInteger     distance;
@property (nonatomic, copy)   NSString     *subtype;
@property (nonatomic, copy)   NSString     *typeCode;
@end
 
@interface AMapRoutePOI : AMapSearchObject
@property (nonatomic, copy)   NSString     *uid;
@property (nonatomic, copy)   NSString     *name;
@property (nonatomic, copy)   AMapGeoPoint *location;
@property (nonatomic, assign) NSInteger     distance;
@property (nonatomic, assign) NSInteger     duration;
@end
 
@interface AMapPOI : AMapSearchObject
@property (nonatomic, copy)   NSString     *uid;
@property (nonatomic, copy)   NSString     *name;
@property (nonatomic, copy)   NSString     *type;
@property (nonatomic, copy)   NSString     *typecode;
@property (nonatomic, copy)   AMapGeoPoint *location;
@property (nonatomic, copy)   NSString     *address;
@property (nonatomic, copy)   NSString     *tel;
@property (nonatomic, assign) NSInteger     distance __attribute__((deprecated("已废弃, from 9.4.0")));
@property (nonatomic, copy)   NSString     *parkingType;
@property (nonatomic, copy)   NSString     *shopID;
 
@property (nonatomic, copy)   NSString     *postcode;
@property (nonatomic, copy)   NSString     *website;
@property (nonatomic, copy)   NSString     *email;
@property (nonatomic, copy)   NSString     *province;
@property (nonatomic, copy)   NSString     *pcode;
@property (nonatomic, copy)   NSString     *city;
@property (nonatomic, copy)   NSString     *citycode;
@property (nonatomic, copy)   NSString     *district;
@property (nonatomic, copy)   NSString     *adcode;
@property (nonatomic, copy)   NSString     *naviPOIId;
@property (nonatomic, copy)   NSString     *gridcode;
@property (nonatomic, copy)   AMapGeoPoint *enterLocation;
@property (nonatomic, copy)   AMapGeoPoint *exitLocation;
@property (nonatomic, copy)   NSString     *direction;
@property (nonatomic, assign) BOOL          hasIndoorMap;
@property (nonatomic, copy)   NSString     *businessArea;
@property (nonatomic, strong) AMapIndoorData *indoorData;
@property (nonatomic, strong) NSArray<AMapSubPOI *> *subPOIs;
@property (nonatomic, strong) NSArray<AMapImage *> *images;
@property (nonatomic, strong) AMapBusinessData *businessData;
@property (nonatomic, strong) AMapPOIExtension *extensionInfo;
@end
 
#pragma mark - 逆地理编码 && 地理编码
 
@interface AMapAOI : AMapSearchObject
@property (nonatomic, copy)   NSString     *uid;
@property (nonatomic, copy)   NSString     *name;
@property (nonatomic, copy)   NSString     *adcode;
@property (nonatomic, copy)   AMapGeoPoint *location;
@property (nonatomic, assign) CGFloat      area;
@end
 
@interface AMapRoad : AMapSearchObject
@property (nonatomic, copy)   NSString     *uid; 
@property (nonatomic, copy)   NSString     *name; 
@property (nonatomic, assign) NSInteger     distance; 
@property (nonatomic, copy)   NSString     *direction; 
@property (nonatomic, copy)   AMapGeoPoint *location;
@end
 
@interface AMapRoadInter : AMapSearchObject
@property (nonatomic, assign) NSInteger     distance; 
@property (nonatomic, copy)   NSString     *direction; 
@property (nonatomic, copy)   AMapGeoPoint *location; 
@property (nonatomic, copy)   NSString     *firstId; 
@property (nonatomic, copy)   NSString     *firstName; 
@property (nonatomic, copy)   NSString     *secondId; 
@property (nonatomic, copy)   NSString     *secondName;
@end
 
@interface AMapStreetNumber : AMapSearchObject
@property (nonatomic, copy)   NSString     *street; 
@property (nonatomic, copy)   NSString     *number; 
@property (nonatomic, copy)   AMapGeoPoint *location; 
@property (nonatomic, assign) NSInteger     distance; 
@property (nonatomic, copy)   NSString     *direction;
@end
 
@interface AMapBusinessArea : AMapSearchObject
@property (nonatomic, strong) NSString     *name; 
@property (nonatomic, copy)   AMapGeoPoint *location;
@end
 
@interface AMapAddressComponent : AMapSearchObject
@property (nonatomic, copy)   NSString         *country;
@property (nonatomic, copy)   NSString         *countryCode;
@property (nonatomic, copy)   NSString         *province; 
@property (nonatomic, copy)   NSString         *city; 
@property (nonatomic, copy)   NSString         *citycode; 
@property (nonatomic, copy)   NSString         *district; 
@property (nonatomic, copy)   NSString         *adcode; 
@property (nonatomic, copy)   NSString         *township; 
@property (nonatomic, copy)   NSString         *towncode; 
@property (nonatomic, copy)   NSString         *neighborhood; 
@property (nonatomic, copy)   NSString         *building; 
@property (nonatomic, strong) AMapStreetNumber *streetNumber; 
@property (nonatomic, strong) NSArray<AMapBusinessArea *> *businessAreas;
@end
 
@interface AMapReGeocode : AMapSearchObject
@property (nonatomic, copy)   NSString             *formattedAddress; 
@property (nonatomic, strong) AMapAddressComponent *addressComponent; 
 
@property (nonatomic, strong) NSArray<AMapRoad *> *roads; 
@property (nonatomic, strong) NSArray<AMapRoadInter *> *roadinters; 
@property (nonatomic, strong) NSArray<AMapPOI *> *pois; 
@property (nonatomic, strong) NSArray<AMapAOI *> *aois;
@end
 
@interface AMapGeocode : AMapSearchObject
@property (nonatomic, copy) NSString     *formattedAddress; 
@property (nonatomic, copy) NSString     *province; 
@property (nonatomic, copy) NSString     *city; 
@property (nonatomic, copy) NSString     *citycode; 
@property (nonatomic, copy) NSString     *district; 
@property (nonatomic, copy) NSString     *adcode; 
@property (nonatomic, copy) NSString     *township; 
@property (nonatomic, copy) NSString     *neighborhood; 
@property (nonatomic, copy) NSString     *building; 
@property (nonatomic, copy) AMapGeoPoint *location; 
@property (nonatomic, copy) NSString     *level;
@property (nonatomic, copy)   NSString   *country;
@property (nonatomic, copy)   NSString   *postcode;
@end
 
#pragma mark - 公交查询
@class AMapBusLine;
 
@interface AMapBusStop : AMapSearchObject
@property (nonatomic, copy)   NSString     *uid; 
@property (nonatomic, copy)   NSString     *adcode; 
@property (nonatomic, copy)   NSString     *name; 
@property (nonatomic, copy)   NSString     *citycode; 
@property (nonatomic, copy)   AMapGeoPoint *location; 
@property (nonatomic, strong) NSArray<AMapBusLine *> *buslines; 
@property (nonatomic, copy)   NSString *sequence;
@end
 
@interface AMapBusLine : AMapSearchObject
@property (nonatomic, copy) NSString     *uid; 
@property (nonatomic, copy) NSString     *type; 
@property (nonatomic, copy) NSString     *name; 
@property (nonatomic, copy) NSString     *polyline; 
@property (nonatomic, copy) NSString     *citycode; 
@property (nonatomic, copy) NSString     *startStop; 
@property (nonatomic, copy) NSString     *endStop; 
@property (nonatomic, copy) AMapGeoPoint *location; 
 
@property (nonatomic, copy)   NSString *startTime; 
@property (nonatomic, copy)   NSString *endTime; 
@property (nonatomic, copy)   NSString *company; 
@property (nonatomic, assign) CGFloat distance; 
@property (nonatomic, assign) CGFloat basicPrice; 
@property (nonatomic, assign) CGFloat totalPrice; 
@property (nonatomic, copy)   AMapGeoPolygon *bounds; 
@property (nonatomic, strong) NSArray<AMapBusStop *> *busStops; 
 
@property (nonatomic, strong) AMapBusStop *departureStop; 
@property (nonatomic, strong) AMapBusStop *arrivalStop; 
@property (nonatomic, strong) NSArray<AMapBusStop *> *viaBusStops; 
@property (nonatomic, assign) NSInteger duration;
@property (nonatomic, assign) NSInteger viaNum;
 
@end
 
#pragma mark - 行政区划
@interface AMapDistrict : AMapSearchObject
@property (nonatomic, copy)   NSString     *adcode; 
@property (nonatomic, copy)   NSString     *citycode; 
@property (nonatomic, copy)   NSString     *name; 
@property (nonatomic, copy)   NSString     *level; 
@property (nonatomic, copy)   AMapGeoPoint *center; 
@property (nonatomic, strong) NSArray<AMapDistrict *> *districts; 
@property (nonatomic, strong) NSArray<NSString *> *polylines;
@end
 
#pragma mark - 路径规划
@interface AMapTransitNavi : AMapSearchObject
@property (nonatomic, copy)   NSString     *action;
@property (nonatomic, copy)   NSString     *assistantAction;
/*
 *0，普通道路 1，人行横道 3，地下通道 4，过街天桥
 *5，地铁通道 6，公园 7，广场 8，扶梯 9，直梯
 *10，索道 11，空中通道 12，建筑物穿越通道
 *13，行人通道 14，游船路线 15，观光车路线 16，滑道
 *18，扩路 19，道路附属连接线 20，阶梯 21，斜坡
 *22，桥 23，隧道 30，轮渡
 */
@property (nonatomic, copy)   NSString     *walkType;
@end
 
@interface AMapTMC : AMapSearchObject
@property (nonatomic, assign) NSInteger distance; 
@property (nonatomic, copy)   NSString  *status; 
@property (nonatomic, copy)   NSString  *polyline;
@end
 
@interface AMapStep : AMapSearchObject
@property (nonatomic, copy)   NSString  *instruction; 
@property (nonatomic, copy)   NSString  *orientation; 
@property (nonatomic, copy)   NSString  *road; 
@property (nonatomic, assign) NSInteger  distance; 
@property (nonatomic, assign) NSInteger  duration; 
@property (nonatomic, copy)   NSString  *polyline; 
@property (nonatomic, copy)   NSString  *action; 
@property (nonatomic, copy)   NSString  *assistantAction; 
@property (nonatomic, assign) NSInteger  walkType;
@property (nonatomic, assign) CGFloat    tolls; 
@property (nonatomic, assign) NSInteger  tollDistance; 
@property (nonatomic, copy)   NSString  *tollRoad;
@property (nonatomic, assign) NSInteger totalTrafficLights;
 
@property (nonatomic, strong) NSArray<AMapCity *> *cities;
@property (nonatomic, strong) NSArray<AMapTMC *> *tmcs;
@end
 
@interface AMapPath : AMapSearchObject
@property (nonatomic, assign) NSInteger  distance; 
@property (nonatomic, assign) NSInteger  duration; 
@property (nonatomic, copy)   NSString  *strategy; 
@property (nonatomic, strong) NSArray<AMapStep *> *steps; 
@property (nonatomic, assign) CGFloat    tolls; 
@property (nonatomic, assign) NSInteger  tollDistance; 
@property (nonatomic, assign) NSInteger  totalTrafficLights;
 
@property (nonatomic, assign) NSInteger restriction;
@property (nonatomic, copy)   NSString  *polyline;
 
@end
 
@interface AMapFutureTimeInfoElement : AMapSearchObject
 
@property (nonatomic, assign) NSInteger     duration;
@property (nonatomic, assign) NSInteger     pathindex;
@property (nonatomic, assign) NSInteger     restriction;
@property (nonatomic, strong) NSArray<AMapTMC *> *tmcs;
 
@end
 
@interface AMapFutureTimeInfo : AMapSearchObject
 
@property (nonatomic, copy)   NSString *startTime;
@property (nonatomic, strong) NSArray<AMapFutureTimeInfoElement *> *elements;
@end
 
@interface AMapWalking : AMapSearchObject
@property (nonatomic, copy)   AMapGeoPoint *origin; 
@property (nonatomic, copy)   AMapGeoPoint *destination; 
@property (nonatomic, assign) NSInteger     distance; 
@property (nonatomic, assign) NSInteger     duration; 
@property (nonatomic, strong) NSArray<AMapStep *> *steps; 
@end
 
@interface AMapTaxi : AMapSearchObject
@property (nonatomic, copy)   AMapGeoPoint *origin; 
@property (nonatomic, copy)   AMapGeoPoint *destination; 
@property (nonatomic, assign) NSInteger    distance; 
@property (nonatomic, assign) NSInteger    duration; 
@property (nonatomic, copy)   NSString     *sname; 
@property (nonatomic, copy)   NSString     *tname;
@property (nonatomic, copy)   NSString     *price;
@property (nonatomic, copy)   NSString     *polyline;
@end
 
@interface AMapRailwayStation : AMapSearchObject
@property (nonatomic, copy) NSString     *uid; 
@property (nonatomic, copy) NSString     *name; 
@property (nonatomic, copy) AMapGeoPoint *location; 
@property (nonatomic, copy) NSString     *adcode; 
@property (nonatomic, copy) NSString     *time; 
@property (nonatomic, assign) NSInteger  wait; 
@property (nonatomic, assign) BOOL       isStart; 
@property (nonatomic, assign) BOOL       isEnd; 
@end
 
@interface AMapRailwaySpace : AMapSearchObject
@property (nonatomic, copy) NSString *code; 
@property (nonatomic, assign) CGFloat cost; 
@end
 
@interface AMapRailway : AMapSearchObject
@property (nonatomic, copy) NSString     *uid; 
@property (nonatomic, copy) NSString     *name; 
@property (nonatomic, copy) NSString     *trip; 
@property (nonatomic, copy) NSString     *type; 
@property (nonatomic, assign) NSInteger  distance; 
@property (nonatomic, assign) NSInteger  time; 
@property (nonatomic, strong) AMapRailwayStation *departureStation; 
@property (nonatomic, strong) AMapRailwayStation *arrivalStation; 
@property (nonatomic, strong) NSArray<AMapRailwaySpace *> *spaces; 
 
@property (nonatomic, strong) NSArray<AMapRailwayStation *> *viaStops; 
@property (nonatomic, strong) NSArray<AMapRailway *> *alters;
@end
 
 
@interface AMapSegment : AMapSearchObject
@property (nonatomic, strong) AMapWalking  *walking; 
@property (nonatomic, strong) NSArray<AMapBusLine *> *buslines; 
@property (nonatomic, strong) AMapTaxi     *taxi; 
@property (nonatomic, strong) AMapRailway  *railway; 
@property (nonatomic, copy)   NSString     *enterName; 
@property (nonatomic, copy)   AMapGeoPoint *enterLocation; 
@property (nonatomic, copy)   NSString     *exitName; 
@property (nonatomic, copy)   AMapGeoPoint *exitLocation; 
@end
 
@interface AMapTransit : AMapSearchObject
@property (nonatomic, assign) CGFloat    cost;
@property (nonatomic, assign) NSInteger  duration; 
@property (nonatomic, assign) BOOL       nightflag;
@property (nonatomic, assign) NSInteger  walkingDistance;
@property (nonatomic, strong) NSArray<AMapSegment *> *segments; 
@property (nonatomic, assign) NSInteger  distance;
@end
 
@interface AMapRoute : AMapSearchObject
@property (nonatomic, copy) AMapGeoPoint *origin; 
@property (nonatomic, copy) AMapGeoPoint *destination; 
@property (nonatomic, assign) CGFloat  taxiCost; 
@property (nonatomic, strong) NSArray<AMapPath *> *paths; 
@property (nonatomic, strong) NSArray<AMapTransit *> *transits;
@property (nonatomic, strong) AMapTransitNavi *transitNavi;
@property (nonatomic, copy)   NSString     *polyline;
@end
 
@interface AMapDistanceResult : AMapSearchObject
@property (nonatomic, assign) NSInteger originID;
@property (nonatomic, assign) NSInteger destID;
@property (nonatomic, assign) NSInteger distance;
@property (nonatomic, assign) NSInteger duration;
@property (nonatomic, copy) NSString *info;
@property (nonatomic, assign) NSInteger code;
@end
 
#pragma mark - 天气查询
 
@interface AMapLocalWeatherLive : AMapSearchObject
@property (nonatomic, copy) NSString *adcode; 
@property (nonatomic, copy) NSString *province; 
@property (nonatomic, copy) NSString *city; 
@property (nonatomic, copy) NSString *weather; 
@property (nonatomic, copy) NSString *temperature; 
@property (nonatomic, copy) NSString *windDirection; 
@property (nonatomic, copy) NSString *windPower; 
@property (nonatomic, copy) NSString *humidity; 
@property (nonatomic, copy) NSString *reportTime; 
@end
 
@interface AMapLocalDayWeatherForecast : AMapSearchObject
@property (nonatomic, copy) NSString *date; 
@property (nonatomic, copy) NSString *week; 
@property (nonatomic, copy) NSString *dayWeather; 
@property (nonatomic, copy) NSString *nightWeather;
@property (nonatomic, copy) NSString *dayTemp; 
@property (nonatomic, copy) NSString *nightTemp; 
@property (nonatomic, copy) NSString *dayWind; 
@property (nonatomic, copy) NSString *nightWind; 
@property (nonatomic, copy) NSString *dayPower; 
@property (nonatomic, copy) NSString *nightPower; 
@end
 
@interface AMapLocalWeatherForecast : AMapSearchObject
@property (nonatomic, copy)   NSString *adcode; 
@property (nonatomic, copy)   NSString *province; 
@property (nonatomic, copy)   NSString *city; 
@property (nonatomic, copy)   NSString *reportTime; 
@property (nonatomic, strong) NSArray<AMapLocalDayWeatherForecast *> *casts; 
@end
 
#pragma mark - 附近搜索
@interface AMapNearbyUserInfo : AMapSearchObject
@property (nonatomic, copy)   NSString       *userID; 
@property (nonatomic, copy)   AMapGeoPoint   *location; 
@property (nonatomic, assign) CGFloat         distance; 
@property (nonatomic, assign) NSTimeInterval  updatetime; 
@end
 
#pragma mark - 交通态势
 
@interface AMapTrafficEvaluation : AMapSearchObject
@property (nonatomic, copy) NSString *evaluationDescription;
@property (nonatomic, assign) NSInteger status;
@property (nonatomic, copy) NSString *expedite;
@property (nonatomic, copy) NSString *congested;
@property (nonatomic, copy) NSString *blocked;
@property (nonatomic, copy) NSString *unknown;
@end
 
@interface AMapTrafficRoad : AMapSearchObject
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) NSInteger status;
@property (nonatomic, copy) NSString *direction;
@property (nonatomic, assign) float angle;
@property (nonatomic, assign) float speed;
@property (nonatomic, copy) NSString *polyline;
@end
 
@interface AMapTrafficInfo : AMapSearchObject
@property (nonatomic, copy) NSString *statusDescription;
@property (nonatomic, strong) AMapTrafficEvaluation *evaluation;
@property (nonatomic, strong) NSArray<AMapTrafficRoad*>* roads;
 
@end
 
#pragma mark - 企业地图基础数据类型
 
@interface AMapCloudImage : AMapSearchObject
@property (nonatomic, copy) NSString *uid; 
@property (nonatomic, copy) NSString *preurl; 
@property (nonatomic, copy) NSString *url; 
@end
 
@interface AMapCloudPOI : AMapSearchObject
@property (nonatomic, assign) NSInteger     uid; 
@property (nonatomic, copy)   NSString     *name; 
@property (nonatomic, copy)   AMapGeoPoint *location; 
@property (nonatomic, copy)   NSString     *address;  
@property (nonatomic, strong) NSDictionary *customFields; 
@property (nonatomic, copy)   NSString     *createTime; 
@property (nonatomic, copy)   NSString     *updateTime; 
@property (nonatomic, assign) NSInteger     distance; 
@property (nonatomic, strong) NSArray<AMapCloudImage *> *images __attribute((deprecated("已废弃 since 7.4.0")));
 
@end