AGSNALayerDefinition Class Reference

---

Description

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

A layer definition allows you to specify these inputs by-reference. This is useful when you already have them stored in a data layer of a 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.

The data layer can be part of the network analysis service itself, or it can belong to another service on any server. The network analysis service will automatically fetch input from the data layer at run-time when the analysis is being performed. You can restrict which inputs are used by specificy SQL queries or Spatial relationships.

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:
(id)	- initWithURL:query:
Properties
AGSGeometry *	geometry
NSString *	layerName
AGSQuery *	query
AGSSpatialRelationship	spatialRelationship
NSURL *	URL
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

Reimplemented in AGSWebMapFeatureCollection.

- (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 network analyst service to reference.
	geometry	The geometry used to select which features should be used as inputs
	spatialRelationship	The spatial relationship to apply to the geometry for selecting features.
	where	The where clause for the query to further restrict which features from the data layer should be used as inputs

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 network analyst service to reference.
	where	The where clause for the query to restrict which features from the data layer should be used as inputs.

Returns:

An initialized AGSNALayerDefinition object.

Since:

1.8

- (id) initWithURL:		(NSURL *)	url
query:		(AGSQuery *)	query

Initialize a new AGSNALayerDefinition.

Parameters:

	url	of a data layer in a map or feature service. The network analysis service retrieves features from this data layer at run-time to use as inputs in the analysis.
	query	to restrict which features from the data layer should be used as inputs

Returns:

Availability:

This feature is only available with services from ArcGIS Server 10.1 or above

Since:

2.3

---

Property Documentation

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

The geometry used to select features. The spatialRelationship is applied to this geometry by the network analysis service while selecting which features to use as inputs during the analysis.

See also:

- initWithLayerName:geometry:spatialRelationship:where:

Since:

1.8

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

The name of the data layer in the network analysis service itself. The service retrieves features from this data layer at run-time to use as stops/barriers/facilities/incidents when the analysis is being performed.

Since:

1.8

- (AGSQuery*) query [read, retain]

Query to restrict which features from the data layer should be retrieved.

Availability:

This feature is only available with services from ArcGIS Server 10.1 or above

Since:

2.3

See also:

- initWithURL:query:

- (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

See also:

- initWithLayerName:geometry:spatialRelationship:where:

- (NSURL*) URL [read, copy]

The URL of a data layer in any map or feature service. The network analysis service retrieves features from this data layer at run-time to use as stops/barriers/facilities/incidents when the analysis is being performed.

Availability:

This feature is only available with services from ArcGIS Server 10.1 or above

Since:

2.3

See also:

- initWithURL:query:

- (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: = "POP2000 > 350000".

Since:

1.8

See also:

- initWithLayerName:where: