ArcGIS Runtime SDK for iOS: AGSRouteTask.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSRouteTask.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSLoadableRemoteResourceBase.h>
27 #import <ArcGIS/AGSAPIKeyResource.h>
28 
29 
30 
31 @class AGSRouteTaskInfo;
32 @class AGSRouteParameters;
33 @class AGSRouteResult;
36 @class AGSPortalItem;
37 
38 @protocol AGSCancelable;
39  //Required for Globals API doc
41 
51 
52 #pragma mark -
53 #pragma mark initializers
54 
55 
56 
62 -(instancetype)initWithDataset:(AGSTransportationNetworkDataset*)dataset;
63 
70 +(instancetype)routeTaskWithDataset:(AGSTransportationNetworkDataset*)dataset;
71 
77 -(instancetype)initWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;
78 
85 +(instancetype)routeTaskWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;
86 
92 -(instancetype)initWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;
93 
100 +(instancetype)routeTaskWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;
101 
106 -(instancetype)initWithURL:(NSURL*)URL;
107 
113 +(instancetype)routeTaskWithURL:(NSURL*)URL;
114 
115 #pragma mark -
116 #pragma mark properties
117 
122 @property (nullable, nonatomic, strong, readonly) AGSTransportationNetworkDataset *transportationNetworkDataset;
123 
124 #pragma mark -
125 #pragma mark methods
126 
132 
137 -(id<AGSCancelable>)defaultRouteParametersWithCompletion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;
138 
144 -(id<AGSCancelable>)routeParametersWithFeatureCollection:(AGSFeatureCollection*)featureCollection
145  completion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;
146 
152 -(id<AGSCancelable>)routeParametersWithPortalItem:(AGSPortalItem*)portalItem
153  completion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;
154 
160 +(id<AGSCancelable>)routeResultWithPortalItem:(AGSPortalItem*)portalItem
161  completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;
162 
168 +(id<AGSCancelable>)routeResultWithFeatureCollection:(AGSFeatureCollection*)featureCollection
169  completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;
170 
176 -(id<AGSCancelable>)solveRouteWithParameters:(AGSRouteParameters*)routeParameters completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;
177 
178 @end
179 
180 
A lightweight collection of features.
Definition: AGSFeatureCollection.h:46
Definition: AGSLoadableRemoteResourceBase.h:35
Object representing a unit of content in an ArcGIS portal.
Definition: AGSPortalItem.h:93
Input parameters for AGSRouteTask.
Definition: AGSRouteParameters.h:49
Result returned by AGSRouteTask.
Definition: AGSRouteResult.h:43
A task to compute routes and turn-by-turn directions.
Definition: AGSRouteTask.h:50
AGSRouteTaskInfo * routeTaskInfo()
AGSTransportationNetworkDataset * transportationNetworkDataset
Definition: AGSRouteTask.h:122
Metadata about the network analyst service or dataset used by AGSRouteTask.
Definition: AGSRouteTaskInfo.h:44
A transportation network dataset.
Definition: AGSTransportationNetworkDataset.h:37
An interface for getting and setting the API key of an object.
Definition: AGSAPIKeyResource.h:36
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38