ArcGIS Runtime SDK for iOS: AGSRouteTask.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSRouteTask.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 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 #import <ArcGIS/AGSCancelable.h>
29 
30 
31 
32 @class AGSRouteTaskInfo;
33 @class AGSRouteParameters;
34 @class AGSRouteResult;
37 @class AGSPortalItem;
38  //Required for Globals API doc
40 
50 
51 #pragma mark -
52 #pragma mark initializers
53 
54 
55 
61 -(instancetype)initWithDataset:(AGSTransportationNetworkDataset*)dataset;
62 
69 +(instancetype)routeTaskWithDataset:(AGSTransportationNetworkDataset*)dataset;
70 
76 -(instancetype)initWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;
77 
84 +(instancetype)routeTaskWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;
85 
91 -(instancetype)initWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;
92 
99 +(instancetype)routeTaskWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;
100 
105 -(instancetype)initWithURL:(NSURL*)URL;
106 
112 +(instancetype)routeTaskWithURL:(NSURL*)URL;
113 
114 #pragma mark -
115 #pragma mark properties
116 
121 @property (nullable, nonatomic, strong, readonly) AGSTransportationNetworkDataset *transportationNetworkDataset;
122 
123 #pragma mark -
124 #pragma mark methods
125 
131 
136 -(id<AGSCancelable>)defaultRouteParametersWithCompletion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;
137 
143 -(id<AGSCancelable>)routeParametersWithFeatureCollection:(AGSFeatureCollection*)featureCollection
144  completion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;
145 
151 -(id<AGSCancelable>)routeParametersWithPortalItem:(AGSPortalItem*)portalItem
152  completion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;
153 
159 +(id<AGSCancelable>)routeResultWithPortalItem:(AGSPortalItem*)portalItem
160  completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;
161 
167 +(id<AGSCancelable>)routeResultWithFeatureCollection:(AGSFeatureCollection*)featureCollection
168  completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;
169 
175 -(id<AGSCancelable>)solveRouteWithParameters:(AGSRouteParameters*)routeParameters completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;
176 
177 @end
178 
179 
A lightweight collection of features.
Definition: AGSFeatureCollection.h:45
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:49
AGSRouteTaskInfo * routeTaskInfo()
AGSTransportationNetworkDataset * transportationNetworkDataset
Definition: AGSRouteTask.h:121
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