ArcGIS Runtime SDK for iOS: AGSClosestFacilityTask.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSClosestFacilityTask.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 
36  //Required for Globals API doc
38 
50 
51 #pragma mark -
52 #pragma mark initializers
53 
54 
55 
61 -(instancetype)initWithURL:(NSURL*)URL;
62 
71 -(instancetype)initWithDataset:(AGSTransportationNetworkDataset*)dataset;
72 
81 -(instancetype)initWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;
82 
91 -(instancetype)initWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;
92 
93 
99 +(instancetype)closestFacilityTaskWithURL:(NSURL*)URL;
100 
109 +(instancetype)closestFacilityTaskWithDataset:(AGSTransportationNetworkDataset*)dataset;
110 
119 +(instancetype)closestFacilityTaskWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;
120 
129 +(instancetype)closestFacilityTaskWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;
130 
131 #pragma mark -
132 #pragma mark properties
133 
138 @property (nullable, nonatomic, strong, readonly) AGSClosestFacilityTaskInfo *closestFacilityTaskInfo;
139 
144 @property (nullable, nonatomic, strong, readonly) AGSTransportationNetworkDataset *transportationNetworkDataset;
145 
146 #pragma mark -
147 #pragma mark methods
148 
153 -(id<AGSCancelable>)defaultClosestFacilityParametersWithCompletion:(void(^)(AGSClosestFacilityParameters * __nullable closestFacilityParameters, NSError * __nullable error))completion;
154 
160 -(id<AGSCancelable>)solveClosestFacilityWithParameters:(AGSClosestFacilityParameters*)closestFacilityParameters completion:(void(^)(AGSClosestFacilityResult * __nullable closestFacilityResult, NSError * __nullable error))completion;
161 
162 @end
163 
164 
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:49
AGSTransportationNetworkDataset * transportationNetworkDataset
Definition: AGSClosestFacilityTask.h:144
AGSClosestFacilityTaskInfo * closestFacilityTaskInfo
Definition: AGSClosestFacilityTask.h:138
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