AGSLengthsParameters Class Reference


Description

Instances of this class represent parameters for AGSGeometryServiceTask's lengthsWithParameters: operation.

Defined in:
AGSGeometryParameters.h ( ArcGIS library)
Since:
1.0
See also:
AGSGeometryServiceTask
Inheritance diagram for AGSLengthsParameters:
<AGSCoding>

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithJSON:
(id) - initWithPolyline:

Static Public Member Functions

(id) + lengthParameters
(id) + lengthParametersWithPolyline:

Properties

BOOL geodesic
AGSSRUnit lengthUnit
NSArray * polylines

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) 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
- (id) initWithPolyline: (AGSPolyline *)  polyline  
Since:
1.8
+ (id) lengthParameters  

Returns an autoreleased instance of the AGSLengthParameters object.

Since:
1.0
+ (id) lengthParametersWithPolyline: (AGSPolyline *)  polyline  

Returns an autoreleased instance of the AGSLengthParameters object initialized with a single polyline.

Since:
1.8

Property Documentation

- (BOOL) geodesic [read, write, assign]

If polylines are in geographic coordinate system, then geodesic needs to be set to true in order to calculate the ellipsoidal shortest path distance between each pair of the vertices in the polylines. If lengthUnit is not specificed, then output is always returned in meters.

Since:
1.0
- (AGSSRUnit) lengthUnit [read, write, assign]

The length unit in which perimeters of polylines will be calculated. It can be any AGSSRUnit constant. If lengthUnit is not specified, the units are derived from the spatial reference of the input polylines.

Since:
1.0
- (NSArray*) polylines [read, write, retain]

The array of polylines whose lengths are to be computed.

Since:
1.0