AGSRelationParameters Class Reference


Description

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

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

List of all members.

Public Member Functions

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

Static Public Member Functions

(id) + relationParameters

Properties

NSArray * geometries1
NSArray * geometries2
AGSGeometryRelation relation
NSString * relationParam

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) relationParameters  

Returns an autoreleased instance of the relation parameters object.

Since:
1.0

Property Documentation

- (NSArray*) geometries1 [read, write, retain]

The first array of geometries to compute the relations. All geometries in this array should be of the type defined by geometryType.

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

The second array of geometries to compute the relations. All geometries in this array should be of the type defined by geometryType.

Since:
1.0
- (AGSGeometryRelation) relation [read, write, assign]

The spatial relationship to be tested between the two input geometry arrays. Note that if the relation is specified as AGSGeometryRelationRelation, the relationParam parameter describes the spatial relationship and must be specified.

Possible values include

  • AGSGeometryRelationCross
  • AGSGeometryRelationDisjoint
  • AGSGeometryRelationIn
  • AGSGeometryRelationInteriorIntersection
  • AGSGeometryRelationIntersection
  • AGSGeometryRelationLineCoincidence
  • AGSGeometryRelationLineTouch
  • AGSGeometryRelationOverlap
  • AGSGeometryRelationPointTouch
  • AGSGeometryRelationTouch
  • AGSGeometryRelationWithin
  • AGSGeometryRelationRelation
    Since:
    1.0
- (NSString*) relationParam [read, write, copy]

The 'Shape Comparison Language' string to be evaluated. Strings such as RELATE (G1, G2, "FFFTTT***") are accepted, in addition to other kinds of strings. The string describes the spatial relationship to be tested when the relation parameter is specified as AGSGeometryRelationRelation.

Since:
1.0
See also:
AGSQuery::relationParam for more information.