AGSStop.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
 */
 //Required for Globals API doc

#import <ArcGIS/AGSObject.h>
#import <ArcGIS/AGSRouteTypes.h>



typedef NS_ENUM(NSUInteger, AGSStopType) {
    AGSStopTypeStop = 0,        
    AGSStopTypeWaypoint = 1,    
    AGSStopTypeRestBreak = 2    
};

@class AGSPoint;
@class AGSNetworkLocation;

@interface AGSStop : AGSObject <NSCopying>

#pragma mark -
#pragma mark initializers



-(instancetype)initWithPoint:(AGSPoint*)point;

+(instancetype)stopWithPoint:(AGSPoint*)point;

#pragma mark -
#pragma mark properties

@property (nonatomic, assign, readonly) AGSCurbApproach arrivalCurbApproach;

@property (nonatomic, assign, readonly) AGSCurbApproach departureCurbApproach;

@property (nonatomic, assign, readwrite) AGSCurbApproach curbApproach;

@property (nonatomic, assign, readwrite) double currentBearing;

@property (nonatomic, assign, readwrite) double currentBearingTolerance;

@property (nonatomic, assign, readonly) double distanceToNetworkLocation;

@property (nullable, nonatomic, strong, readwrite) AGSPoint *geometry;

@property (nullable, nonatomic, strong, readonly) NSDate *arrivalTime;

@property (nonatomic, assign, readonly) double arrivalTimeShift;

@property (nullable, nonatomic, strong, readonly) NSDate *departureTime;

@property (nonatomic, assign, readonly) double departureTimeShift;

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

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

@property (nonatomic, assign, readonly) AGSLocationStatus locationStatus;

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

@property (nonatomic, assign, readwrite) AGSStopType stopType;

@property (nonatomic, assign, readwrite) NSInteger stopID;

@property (nonatomic, assign, readwrite) double navigationLatency;

@property (nonatomic, assign, readwrite) double navigationSpeed;

@property (nullable, nonatomic, strong, readwrite) AGSNetworkLocation *networkLocation;

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

@property (nonatomic, assign, readonly) NSInteger sequence;

@property (nonatomic, assign, readonly) double violationTime;

@property (nonatomic, assign, readonly) double waitTime;

#pragma mark -
#pragma mark methods

-(double)addedCostForCostAttribute:(NSString*)attributeName;

-(void)setAddedCost:(double)addedCost forCostAttribute:(NSString*)attributeName;

-(double)cumulativeCostForCostAttribute:(NSString*)attributeName;

@end