AGSNALayerDefinition Class Reference

---

Description

Instances of this class represent possible inputs for the stops/facilities/incidents/barriers properties of AGSRouteTaskParameters, AGSServiceAreaTaskParameters, and AGSClosestFacilityTaskParameters.

A layer definition allows you to specify these inputs by-reference. This is useful when you already have a set the inputs stored along with the Network Analyst service. In such cases, the application does not need to know the actual details about each input. All it needs to do is set up a layer definition specifiying which inputs should be included in the analysis. You can use SQL statements and/or Spatial relationships to specify which inputs should be used in the analysis

Since:

1.8

Inheritance diagram for AGSNALayerDefinition:

List of all members.

Public Member Functions
(void)	- decodeWithJSON:
(NSDictionary *)	- encodeToJSON
(id)	- initWithJSON:
(id)	- initWithLayerName:geometry:spatialRelationship:where:
(id)	- initWithLayerName:where:
Properties
AGSGeometry *	geometry
NSString *	layerName
AGSSpatialRelationship	spatialRelationship
NSString *	where

---

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) initWithLayerName:		(NSString *)	layerName
geometry:		(AGSGeometry *)	geometry
spatialRelationship:		(AGSSpatialRelationship)	spatialRelationship
where:		(NSString *)	where

Initialize a new AGSNALayerDefinition.

Parameters:

	layerName	The name of the data layer in the map service to reference.
	geometry	The geometry to apply the spatial filter on.
	spatialRelationship	The spatial relationship to apply to the geometry.
	where	The where clause for the query.

Returns:

An initialized AGSNALayerDefinition object.

Since:

1.8

- (id) initWithLayerName:		(NSString *)	layerName
where:		(NSString *)	where

Initialize a new AGSNALayerDefinition.

Parameters:

	layerName	The name of the data layer in the map service to reference.
	where	The where clause for the query.

Returns:

An initialized AGSNALayerDefinition object.

Since:

1.8

---

Property Documentation

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

The geometry to apply to the spatial filter. The spatial relationship as specified by spatialRelationship is applied to this geometry while performing the query.

Since:

1.8

- (NSString*) layerName [read, write, copy]

The name of the data layer in the map service that is being referenced.

Since:

1.8

- (AGSSpatialRelationship) spatialRelationship [read, write, assign]

The spatial relationship to be applied on the input geometry while performing the query. See the Constants Table for a list of valid values. The default spatial relationship is AGSSpatialRelationshipIntersects.

Since:

1.8

- (NSString*) where [read, write, copy]

A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed, for example: query.where = "POP2000 > 350000".

Since:

1.8