AGSDistanceParameters Class Reference

---

Description

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

Defined in:

AGSGeometryParameters.h ( ArcGIS library)

Since:

1.0

See also:

AGSGeometryServiceTask

Inheritance diagram for AGSDistanceParameters:

List of all members.

Public Member Functions
(void)	- decodeWithJSON:
(NSDictionary *)	- encodeToJSON
(id)	- initWithJSON:
Static Public Member Functions
(id)	+ distanceParameters
Properties
AGSSRUnit	distanceUnit
BOOL	geodesic
AGSGeometry *	geometry1
AGSGeometry *	geometry2

---

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

+ (id) distanceParameters

Returns an autoreleased instance of the distance parameters object.

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

---

Property Documentation

- (AGSSRUnit) distanceUnit [read, write, assign]

Specifies the units for measuring distance between geometry1 and geometry2. If the unit is not specified the units are derived from the spatial reference of the input geometries.

Since:

1.0

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

Default value is false. When true the geodesic distance between geometry1 and geometry2 is measured.

Since:

1.0

- (AGSGeometry*) geometry1 [read, write, retain]

The geometry from which the distance is to measured. The geometry can be one of the following geometry types: AGSPoint, AGSPolyline, AGSPolygon or AGSMultipoint.

Since:

1.0

- (AGSGeometry*) geometry2 [read, write, retain]

The geometry to which the distance is measured. The geometry can be one of the following geomtry types: AGSPoint, AGSPolyline, AGSPolygon or AGSMultipoint.

Since:

1.0