ArcGIS Runtime SDK for iOS: AGSClosestFacilityTask.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSClosestFacilityTask.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 
35 
36 @protocol AGSCancelable;
37  //Required for Globals API doc
39 
51 
52 #pragma mark -
53 #pragma mark initializers
54 
55 
56 
62 -(instancetype)initWithURL:(NSURL*)URL;
63 
72 -(instancetype)initWithDataset:(AGSTransportationNetworkDataset*)dataset;
73 
82 -(instancetype)initWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;
83 
92 -(instancetype)initWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;
93 
94 
100 +(instancetype)closestFacilityTaskWithURL:(NSURL*)URL;
101 
110 +(instancetype)closestFacilityTaskWithDataset:(AGSTransportationNetworkDataset*)dataset;
111 
120 +(instancetype)closestFacilityTaskWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;
121 
130 +(instancetype)closestFacilityTaskWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;
131 
132 #pragma mark -
133 #pragma mark properties
134 
139 @property (nullable, nonatomic, strong, readonly) AGSClosestFacilityTaskInfo *closestFacilityTaskInfo;
140 
145 @property (nullable, nonatomic, strong, readonly) AGSTransportationNetworkDataset *transportationNetworkDataset;
146 
147 #pragma mark -
148 #pragma mark methods
149 
154 -(id<AGSCancelable>)defaultClosestFacilityParametersWithCompletion:(void(^)(AGSClosestFacilityParameters * __nullable closestFacilityParameters, NSError * __nullable error))completion;
155 
161 -(id<AGSCancelable>)solveClosestFacilityWithParameters:(AGSClosestFacilityParameters*)closestFacilityParameters completion:(void(^)(AGSClosestFacilityResult * __nullable closestFacilityResult, NSError * __nullable error))completion;
162 
163 @end
164 
165 
Input parameters for AGSClosestFacilityTask.
Definition: AGSClosestFacilityParameters.h:52
Result returned by AGSClosestFacilityTask.
Definition: AGSClosestFacilityResult.h:45
A task to find facilities closest to an incident.
Definition: AGSClosestFacilityTask.h:50
AGSTransportationNetworkDataset * transportationNetworkDataset
Definition: AGSClosestFacilityTask.h:145
AGSClosestFacilityTaskInfo * closestFacilityTaskInfo
Definition: AGSClosestFacilityTask.h:139
Metadata about the network analyst service or dataset used by AGSClosestFacilityTask.
Definition: AGSClosestFacilityTaskInfo.h:45
Definition: AGSLoadableRemoteResourceBase.h:35
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