AGSRouteParameters.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/AGSObject.h>
#import <ArcGIS/AGSUnitSystem.h>
#import <ArcGIS/AGSRouteTypes.h>

@class AGSSpatialReference;
@class AGSTravelMode;
@class AGSArcGISFeatureTable;
@class AGSQueryParameters;
@class AGSPointBarrier;
@class AGSPolylineBarrier;
@class AGSPolygonBarrier;
@class AGSStop;
 //Required for Globals API doc

@interface AGSRouteParameters : AGSObject <NSCopying>


#pragma mark -
#pragma mark initializers

-(instancetype)init;
+(instancetype)routeParameters;

#pragma mark -
#pragma mark properties

@property (nonatomic, copy, readwrite) NSArray<NSString*> *accumulateAttributeNames;

@property (nonatomic, assign, readwrite) AGSUnitSystem directionsDistanceUnits;

@property (nonatomic, copy, readwrite) NSString *directionsLanguage;

@property (nonatomic, assign, readwrite) AGSDirectionsStyle directionsStyle;

@property (nonatomic, assign, readwrite) BOOL findBestSequence;

@property (nullable, nonatomic, strong, readwrite) NSDate *startTime;

@property (nullable, nonatomic, strong, readwrite) AGSSpatialReference *outputSpatialReference;

@property (nonatomic, assign, readwrite) BOOL preserveFirstStop;

@property (nonatomic, assign, readwrite) BOOL preserveLastStop;

@property (nonatomic, assign, readwrite) BOOL returnDirections;

@property (nonatomic, assign, readwrite) BOOL returnPointBarriers;

@property (nonatomic, assign, readwrite) BOOL returnPolygonBarriers;

@property (nonatomic, assign, readwrite) BOOL returnPolylineBarriers;

@property (nonatomic, assign, readwrite) BOOL returnRoutes;

@property (nonatomic, assign, readwrite) BOOL returnStops;

@property (nonatomic, assign, readwrite) AGSRouteShapeType routeShapeType;

@property (nullable, nonatomic, strong, readwrite) AGSTravelMode *travelMode;

#pragma mark -
#pragma mark methods

-(void)clearPointBarriers;

-(void)clearPolygonBarriers;

-(void)clearPolylineBarriers;

-(void)clearStops;

-(void)setPointBarriers:(NSArray<AGSPointBarrier*>*)pointBarriers;

-(void)setPointBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;

-(void)setPolygonBarriers:(NSArray<AGSPolygonBarrier*>*)polygonBarriers;

-(void)setPolygonBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;

-(void)setPolylineBarriers:(NSArray<AGSPolylineBarrier*>*)lineBarriers;

-(void)setPolylineBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;

-(void)setStops:(NSArray<AGSStop*>*)stops;

-(void)setStopsWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;

-(NSString*)searchWhereClauseForSourceName:(NSString*)sourceName;

-(void)setSearchWhereClause:(NSString*)searchWhereClause forSourceName:(NSString*)sourceName;


@end