ArcGIS Runtime SDK for iOS: AGSUtilityNearestNeighbor.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSUtilityNearestNeighbor.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSObject.h>
29 
30 
31 
32 @class AGSUtilityAssetType;
33 @class AGSUtilityCategory;
35 
40 
41 #pragma mark -
42 #pragma mark initializers
43 
44 
45 
52 -(nullable instancetype)initWithCostNetworkAttribute:(AGSUtilityNetworkAttribute *)costNetworkAttribute
53  count:(NSInteger)count
54  assetTypes:(NSArray<AGSUtilityAssetType *> *)assetTypes;
55 
63 +(nullable instancetype)nearestNeighborWithCostNetworkAttribute:(AGSUtilityNetworkAttribute *)costNetworkAttribute
64  count:(NSInteger)count
65  assetTypes:(NSArray<AGSUtilityAssetType *> *)assetTypes;
66 
74 -(nullable instancetype)initWithCostNetworkAttribute:(AGSUtilityNetworkAttribute *)costNetworkAttribute
75  count:(NSInteger)count
76  assetTypes:(NSArray<AGSUtilityAssetType *> *)assetTypes
77  categories:(NSArray<AGSUtilityCategory *> *)categories;
78 
87 +(nullable instancetype)nearestNeighborWithCostNetworkAttribute:(AGSUtilityNetworkAttribute *)costNetworkAttribute
88  count:(NSInteger)count
89  assetTypes:(NSArray<AGSUtilityAssetType *> *)assetTypes
90  categories:(NSArray<AGSUtilityCategory *> *)categories;
91 
98 -(nullable instancetype)initWithCostNetworkAttribute:(AGSUtilityNetworkAttribute *)costNetworkAttribute
99  count:(NSInteger)count
100  categories:(NSArray<AGSUtilityCategory *> *)categories;
101 
109 +(nullable instancetype)nearestNeighborWithCostNetworkAttribute:(AGSUtilityNetworkAttribute *)costNetworkAttribute
110  count:(NSInteger)count
111  categories:(NSArray<AGSUtilityCategory *> *)categories;
112 
113 #pragma mark -
114 #pragma mark properties
115 
119 @property (nonatomic, strong, readonly) AGSUtilityNetworkAttribute *costNetworkAttribute;
120 
124 @property (nonatomic, assign, readonly) NSInteger count;
125 
130 @property (nonatomic, copy, readonly) NSArray<AGSUtilityAssetType *> *assetTypes;
131 
136 @property (nonatomic, copy, readonly) NSArray<AGSUtilityCategory *> *categories;
137 
138 #pragma mark -
139 #pragma mark methods
140 
141 @end
142 
143 
Definition: AGSObject.h:28
A utility network asset type.
Definition: AGSUtilityAssetType.h:58
A category used to define a characteristic of an asset in a network.
Definition: AGSUtilityCategory.h:38
A filter set on the AGSUtilityTraceFilter::nearestNeighbor property to return the next N features fro...
Definition: AGSUtilityNearestNeighbor.h:40
NSArray< AGSUtilityCategory * > * categories
Definition: AGSUtilityNearestNeighbor.h:136
AGSUtilityNetworkAttribute * costNetworkAttribute
Definition: AGSUtilityNearestNeighbor.h:119
NSArray< AGSUtilityAssetType * > * assetTypes
Definition: AGSUtilityNearestNeighbor.h:130
NSInteger count
Definition: AGSUtilityNearestNeighbor.h:124
A network attribute in a utility network.
Definition: AGSUtilityNetworkAttribute.h:58