AGSStopGraphic Class Reference
Description
Instances of this class represent stops - locations that must be visited along a route. Stops are used as inputs to the solve operation of an AGSRouteTask. You need atleast two stops to compute a route, although you can have more.
Apart from the properties declared on this class, a stop can have additional properties depending upon how the Route layer in the Network Analyst service is configured. These properties can be set and accessed through the attributes property.
- Since:
- 1.8
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithGeometry:symbol:attributes:infoTemplateDelegate: |
| (id) | - initWithJSON: |
Static Public Member Functions | |
| (id) | + graphicWithGeometry:symbol:attributes:infoTemplateDelegate: |
Properties | |
| NSMutableDictionary * | attributes |
| AGSGeometry * | geometry |
| id< AGSInfoTemplateDelegate > | infoTemplateDelegate |
| AGSGraphicsLayer * | layer |
| NSString * | name |
| NSString * | routeName |
| NSUInteger | sequence |
| AGSSymbol * | symbol |
| NSDate * | timeWindowEnd |
| NSDate * | timeWindowStart |
| BOOL | visible |
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| + (id) graphicWithGeometry: | (AGSGeometry *) | geometry | ||
| symbol: | (AGSSymbol *) | symbol | ||
| attributes: | (NSMutableDictionary *) | attributes | ||
| infoTemplateDelegate: | (id< AGSInfoTemplateDelegate >) | infoTemplateDelegate | ||
Returns autoreleased graphic object. Only the geometry argument is mandatory.
- Parameters:
-
geometry The geometry defining the graphic. symbol The symbol used to draw the graphic. Can be nil. attributes Name-value pairs of fields and field values associated with the graphic. infoTemplateDelegate The template describing how to display attributesin the callout. Can be nil.
- Returns:
- A new, autoreleased, graphic object.
- Since:
- 1.0
| - (id) initWithGeometry: | (AGSGeometry *) | geometry | ||
| symbol: | (AGSSymbol *) | symbol | ||
| attributes: | (NSMutableDictionary *) | attributes | ||
| infoTemplateDelegate: | (id< AGSInfoTemplateDelegate >) | infoTemplateDelegate | ||
Initialize the graphic object. Only the geometry argument is mandatory.
- Parameters:
-
geometry The geometry defining the graphic. symbol The symbol used to draw the graphic. Can be nil. attributes Name-value pairs of fields and field values associated with the graphic. infoTemplateDelegate The template describing how to display attributesin the callout. Can be nil.
- Returns:
- A new graphic object.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
Property Documentation
- (NSMutableDictionary*) attributes [read, write, retain, inherited] |
Attributes representing additional information about this graphic. Consists of key-value pairs of field names and field values.
- Since:
- 1.0
- (AGSGeometry*) geometry [read, write, retain, inherited] |
The geometry that defines the graphic's shape and location.
- Since:
- 1.0
- (id<AGSInfoTemplateDelegate>) infoTemplateDelegate [read, write, assign, inherited] |
Template describing how the callout should display this graphic's attributes.
- See also:
- AGSCalloutTemplate
- Since:
- 1.0
- (AGSGraphicsLayer*) layer [read, assign, inherited] |
The graphics layer that this graphic belongs to, if any.
- Since:
- 1.8
- (NSString*) name [read, write, assign] |
A user-friendly name of the stop.
- Since:
- 1.8
- (NSString*) routeName [read, write, assign] |
The name of the route associated with the stop. You should specify a routeName if you want to group stops into different routes. Stops having the same routeName will be assigned a separate route, and stops without a routeName will not be included in the analysis. If you do not assign a routeName to any stops, all stops will be combined into a single route.
- Since:
- 1.8
- (NSUInteger) sequence [read, write, assign] |
An integer representing the index of the stop. This index value is 1-based. The sequence number indicates the sequence in which you want the stop to be visited by the route.
If you enable the findBestSequence property on AGSRouteTaskParameters, the service will attempt to reorder the stops to find the most optimal route. You can also enable the preserveFirstStop and preserveLastStop properties on AGSRouteTaskParameters if you do not want the origin and destination stops to be reordered.
- Since:
- 1.8
- (AGSSymbol*) symbol [read, write, retain, inherited] |
The symbol for the graphic.
- Since:
- 1.0
- (NSDate*) timeWindowEnd [read, write, assign] |
TThe ending time of a permissible time window for the stop. This is only honored if the useTimeWindows property of AGSRouteParameters is true, The route will attempt to visit the stop only within its time window, if possible.
- Since:
- 1.8
- (NSDate*) timeWindowStart [read, write, assign] |
The begining time of a permissible time window for the stop. This is only honored if the useTimeWindows property of AGSRouteParameters is true. The route will attempt to visit the stop only within its time window, if possible.
- Since:
- 1.8
- (BOOL) visible [read, write, assign, inherited] |
Whether or not the graphic is visible in the layer.
- Since:
- 2.1