AGSUtilityNearestNeighbor Class Reference

Description

A filter set on the AGSUtilityTraceFilter::nearestNeighbor property to return the next N features from the starting point.

Since

100.8

Inheritance diagram for AGSUtilityNearestNeighbor:

Instance Methods
(nullable instancetype)	- initWithCostNetworkAttribute:count:assetTypes:
(nullable instancetype)	- initWithCostNetworkAttribute:count:assetTypes:categories:
(nullable instancetype)	- initWithCostNetworkAttribute:count:categories:

Class Methods
(nullable instancetype)	+ nearestNeighborWithCostNetworkAttribute:count:assetTypes:
(nullable instancetype)	+ nearestNeighborWithCostNetworkAttribute:count:assetTypes:categories:
(nullable instancetype)	+ nearestNeighborWithCostNetworkAttribute:count:categories:

Properties
NSArray< AGSUtilityAssetType * > *	assetTypes
NSArray< AGSUtilityCategory * > *	categories
AGSUtilityNetworkAttribute *	costNetworkAttribute
NSInteger	count

Method Documentation

initWithCostNetworkAttribute:count:assetTypes:

- (nullable instancetype) initWithCostNetworkAttribute:		(AGSUtilityNetworkAttribute *)	costNetworkAttribute
count:		(NSInteger)	count
assetTypes:		(NSArray< AGSUtilityAssetType * > *)	assetTypes

Creates a filter object to return the next N features from the starting point.

Parameters

costNetworkAttribute	The AGSUtilityNetworkAttribute used to determine the definition of "nearest".
count	The number of nearest features to return.
assetTypes	The array of AGSUtilityAssetType that are used to define features to return.

Since

100.8

initWithCostNetworkAttribute:count:assetTypes:categories:

- (nullable instancetype) initWithCostNetworkAttribute:		(AGSUtilityNetworkAttribute *)	costNetworkAttribute
count:		(NSInteger)	count
assetTypes:		(NSArray< AGSUtilityAssetType * > *)	assetTypes
categories:		(NSArray< AGSUtilityCategory * > *)	categories

Creates a filter object to return the next N features from the starting point.

Parameters

costNetworkAttribute	The AGSUtilityNetworkAttribute used to determine the definition of "nearest".
count	The number of nearest features to return.
assetTypes	The array of AGSUtilityAssetType that are used to define features to return.
categories	The array of AGSUtilityCategory that are used to define features to return.

Since

100.8

initWithCostNetworkAttribute:count:categories:

- (nullable instancetype) initWithCostNetworkAttribute:		(AGSUtilityNetworkAttribute *)	costNetworkAttribute
count:		(NSInteger)	count
categories:		(NSArray< AGSUtilityCategory * > *)	categories

Creates a filter object to return the next N features from the starting point.

Parameters

costNetworkAttribute	The AGSUtilityNetworkAttribute used to determine the definition of "nearest".
count	The number of nearest features to return.
categories	The array of AGSUtilityCategory that are used to define features to return.

Since

100.8

nearestNeighborWithCostNetworkAttribute:count:assetTypes:

+ (nullable instancetype) nearestNeighborWithCostNetworkAttribute:		(AGSUtilityNetworkAttribute *)	costNetworkAttribute
count:		(NSInteger)	count
assetTypes:		(NSArray< AGSUtilityAssetType * > *)	assetTypes

Creates a filter object to return the next N features from the starting point.

Parameters

costNetworkAttribute	The AGSUtilityNetworkAttribute used to determine the definition of "nearest".
count	The number of nearest features to return.
assetTypes	The array of AGSUtilityAssetType that are used to define features to return.

Returns

A new AGSUtilityNearestNeighbor object.

Since

100.8

nearestNeighborWithCostNetworkAttribute:count:assetTypes:categories:

+ (nullable instancetype) nearestNeighborWithCostNetworkAttribute:		(AGSUtilityNetworkAttribute *)	costNetworkAttribute
count:		(NSInteger)	count
assetTypes:		(NSArray< AGSUtilityAssetType * > *)	assetTypes
categories:		(NSArray< AGSUtilityCategory * > *)	categories

Creates a filter object to return the next N features from the starting point.

Parameters

costNetworkAttribute	The AGSUtilityNetworkAttribute used to determine the definition of "nearest".
count	The number of nearest features to return.
assetTypes	The array of AGSUtilityAssetType that are used to define features to return.
categories	The array of AGSUtilityCategory that are used to define features to return.

Returns

A new AGSUtilityNearestNeighbor object.

Since

100.8

nearestNeighborWithCostNetworkAttribute:count:categories:

+ (nullable instancetype) nearestNeighborWithCostNetworkAttribute:		(AGSUtilityNetworkAttribute *)	costNetworkAttribute
count:		(NSInteger)	count
categories:		(NSArray< AGSUtilityCategory * > *)	categories

Creates a filter object to return the next N features from the starting point.

Parameters

costNetworkAttribute	The AGSUtilityNetworkAttribute used to determine the definition of "nearest".
count	The number of nearest features to return.
categories	The array of AGSUtilityCategory that are used to define features to return.

Returns

A new AGSUtilityNearestNeighbor object.

Since

100.8

Property Documentation

assetTypes

- (NSArray<AGSUtilityAssetType *>*) assetTypes

readnonatomiccopy

The array of AGSUtilityAssetType that are used to define features to return. Can be empty when the AGSUtilityNearestNeighbor is created with an array of AGSUtilityCategory.

Since

100.8

categories

- (NSArray<AGSUtilityCategory *>*) categories

readnonatomiccopy

The array of AGSUtilityCategory that are used to define features to return. Can be empty when the AGSUtilityNearestNeighbor is created with an array of AGSUtilityAssetType.

Since

100.8

costNetworkAttribute

- (AGSUtilityNetworkAttribute*) costNetworkAttribute

readnonatomicstrong

The AGSUtilityNetworkAttribute used to determine the definition of "nearest".

Since

100.8

count

- (NSInteger) count

readnonatomicassign

The number of nearest features to return

Since

100.8