ArcGIS Runtime SDK for iOS: AGSUtilityDomainNetwork.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSUtilityDomainNetwork.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 
33 @class AGSUtilityTier;
34 @class AGSUtilityTierGroup;
35 
40 typedef NS_ENUM(NSInteger, AGSUtilitySubnetworkControllerType) {
44 };
45 
50 typedef NS_ENUM(NSInteger, AGSUtilityTierType) {
53 };
54 
68 
69 #pragma mark -
70 #pragma mark initializers
71 
72 
73 
74 #pragma mark -
75 #pragma mark properties
76 
81 @property (nonatomic, copy, readonly) NSString *alias;
82 
86 @property (nonatomic, assign, readonly) NSInteger domainNetworkID;
87 
91 @property (nonatomic, copy, readonly) NSString *name;
92 
96 @property (nonatomic, copy, readonly) NSArray<AGSUtilityNetworkSource *> *networkSources;
97 
101 @property (nonatomic, assign, readonly, getter=isStructureNetwork) BOOL structureNetwork;
102 
106 @property (nonatomic, assign, readonly) AGSUtilitySubnetworkControllerType subnetworkControllerType;
107 
112 @property (nonatomic, copy, readonly) NSArray<AGSUtilityTierGroup *> *tierGroups;
113 
117 @property (nonatomic, copy, readonly) NSArray<AGSUtilityTier *> *tiers;
118 
123 @property (nonatomic, assign, readonly) AGSUtilityTierType tierType;
124 
125 #pragma mark -
126 #pragma mark methods
127 
133 -(nullable AGSUtilityTierGroup *)tierGroupWithName:(NSString *)name;
134 
140 -(nullable AGSUtilityTier *)tierWithName:(NSString *)name;
141 
142 @end
143 
144 
AGSUtilitySubnetworkControllerType
Definition: AGSUtilityDomainNetwork.h:40
@ AGSUtilitySubnetworkControllerTypeSource
Definition: AGSUtilityDomainNetwork.h:42
@ AGSUtilitySubnetworkControllerTypeNone
Definition: AGSUtilityDomainNetwork.h:41
@ AGSUtilitySubnetworkControllerTypeSink
Definition: AGSUtilityDomainNetwork.h:43
AGSUtilityTierType
Definition: AGSUtilityDomainNetwork.h:50
@ AGSUtilityTierTypeHierarchical
Definition: AGSUtilityDomainNetwork.h:51
@ AGSUtilityTierTypePartitioned
Definition: AGSUtilityDomainNetwork.h:52
Definition: AGSObject.h:28
A domain network inside a utility network.
Definition: AGSUtilityDomainNetwork.h:68
NSInteger domainNetworkID
Definition: AGSUtilityDomainNetwork.h:86
NSArray< AGSUtilityTier * > * tiers
Definition: AGSUtilityDomainNetwork.h:117
AGSUtilitySubnetworkControllerType subnetworkControllerType
Definition: AGSUtilityDomainNetwork.h:106
NSArray< AGSUtilityNetworkSource * > * networkSources
Definition: AGSUtilityDomainNetwork.h:96
NSArray< AGSUtilityTierGroup * > * tierGroups
Definition: AGSUtilityDomainNetwork.h:112
NSString * alias
Definition: AGSUtilityDomainNetwork.h:81
NSString * name
Definition: AGSUtilityDomainNetwork.h:91
AGSUtilityTierType tierType
Definition: AGSUtilityDomainNetwork.h:123
BOOL structureNetwork
Definition: AGSUtilityDomainNetwork.h:101
A network source in a utility network.
Definition: AGSUtilityNetworkSource.h:73
Tier groups provide an extra level of organization for tiers.
Definition: AGSUtilityTierGroup.h:42
Tiers demarcate a logical level within a network.
Definition: AGSUtilityTier.h:49