AGSRouteTask.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */

#import <ArcGIS/AGSLoadableRemoteResourceBase.h>



@class AGSRouteTaskInfo;
@class AGSRouteParameters;
@class AGSRouteResult;
@class AGSTransportationNetworkDataset;
@class AGSFeatureCollection;
@class AGSPortalItem;

@protocol AGSCancelable;
 //Required for Globals API doc

@interface AGSRouteTask : AGSLoadableRemoteResourceBase

#pragma mark -
#pragma mark initializers



-(instancetype)initWithDataset:(AGSTransportationNetworkDataset*)dataset;

+(instancetype)routeTaskWithDataset:(AGSTransportationNetworkDataset*)dataset;

-(instancetype)initWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;

+(instancetype)routeTaskWithFileURLToDatabase:(NSURL*)fileURLToDatabase networkName:(NSString*)networkName;

-(instancetype)initWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;

+(instancetype)routeTaskWithDatabaseName:(NSString*)databaseName networkName:(NSString*)networkName;

-(instancetype)initWithURL:(NSURL*)URL;

+(instancetype)routeTaskWithURL:(NSURL*)URL;

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, strong, readonly) AGSTransportationNetworkDataset *transportationNetworkDataset;

#pragma mark -
#pragma mark methods

-(AGSRouteTaskInfo*)routeTaskInfo;

-(id<AGSCancelable>)defaultRouteParametersWithCompletion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;

-(id<AGSCancelable>)routeParametersWithFeatureCollection:(AGSFeatureCollection*)featureCollection
                                              completion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;

-(id<AGSCancelable>)routeParametersWithPortalItem:(AGSPortalItem*)portalItem
                                       completion:(void(^)(AGSRouteParameters * __nullable routeParams, NSError * __nullable error))completion;

+(id<AGSCancelable>)routeResultWithPortalItem:(AGSPortalItem*)portalItem
                                   completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;

+(id<AGSCancelable>)routeResultWithFeatureCollection:(AGSFeatureCollection*)featureCollection
                                          completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;

-(id<AGSCancelable>)solveRouteWithParameters:(AGSRouteParameters*)routeParameters completion:(void(^)(AGSRouteResult * __nullable routeResult, NSError * __nullable error))completion;

@end