Method Create

Create(UtilityNetworkAttribute, Int32, IEnumerable<UtilityAssetType>)

Creates a filter object to return the next N features from the starting point with nearest asset types.

Declaration

public static UtilityNearestNeighbor Create(UtilityNetworkAttribute costNetworkAttribute, int count, IEnumerable<UtilityAssetType> nearestAssetTypes)

Parameters

Type	Name	Description
UtilityNetworkAttribute	costNetworkAttribute	The UtilityNetworkAttribute used to determine the definition of "nearest".
System.Int32	count	The number of nearest features to return. This must be a positive number.
System.Collections.Generic.IEnumerable<UtilityAssetType>	nearestAssetTypes	The collection of UtilityAssetType that are used to define features to return.

Returns

Type	Description
UtilityNearestNeighbor	A UtilityNearestNeighbor with nearest asset types.

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.8 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.8 - 200.8
Xamarin.Android	100.8 - 100.14
Xamarin.iOS	100.8 - 100.15
UWP	100.8 - 200.8

Create(UtilityNetworkAttribute, Int32, IEnumerable<UtilityAssetType>, IEnumerable<UtilityCategory>)

Creates a filter object to return the next N features from the starting point with nearest asset types and nearest categories.

Declaration

public static UtilityNearestNeighbor Create(UtilityNetworkAttribute costNetworkAttribute, int count, IEnumerable<UtilityAssetType> nearestAssetTypes, IEnumerable<UtilityCategory> nearestCategories)

Parameters

Type	Name	Description
UtilityNetworkAttribute	costNetworkAttribute	The UtilityNetworkAttribute used to determine the definition of "nearest".
System.Int32	count	The number of nearest features to return. This must be a positive number.
System.Collections.Generic.IEnumerable<UtilityAssetType>	nearestAssetTypes	The collection of UtilityAssetType that are used to define features to return.
System.Collections.Generic.IEnumerable<UtilityCategory>	nearestCategories	The collection of UtilityCategory that are used to define features to return.

Returns

Type	Description
UtilityNearestNeighbor	A UtilityNearestNeighbor with nearest asset types and nearest categories.

Exceptions

Type	Condition
System.ArgumentException	Invalid nearest neighbor count. -or- The nearestAssetTypes array must not be empty.

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.8 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.8 - 200.8
Xamarin.Android	100.8 - 100.14
Xamarin.iOS	100.8 - 100.15
UWP	100.8 - 200.8

Create(UtilityNetworkAttribute, Int32, IEnumerable<UtilityCategory>)

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

Declaration

public static UtilityNearestNeighbor Create(UtilityNetworkAttribute costNetworkAttribute, int count, IEnumerable<UtilityCategory> nearestCategories)

Parameters

Type	Name	Description
UtilityNetworkAttribute	costNetworkAttribute	The UtilityNetworkAttribute used to determine the definition of "nearest".
System.Int32	count	The number of nearest features to return. This must be a positive number.
System.Collections.Generic.IEnumerable<UtilityCategory>	nearestCategories	The collection of UtilityCategory that are used to define features to return.

Returns

Type	Description
UtilityNearestNeighbor	A UtilityNearestNeighbor with nearest categories.

Exceptions

Type	Condition
System.ArgumentException	Invalid nearest neighbor count. -or- The nearestCategories array must not be empty.

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.8 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.2 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.8 - 200.8
Xamarin.Android	100.8 - 100.14
Xamarin.iOS	100.8 - 100.15
UWP	100.8 - 200.8