ArcGIS Runtime SDK for iOS: AGSArcadeEvaluator.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSArcadeEvaluator.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 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/AGSLoadableBase.h>
29 #import <ArcGIS/AGSCancelable.h>
30 #import <ArcGIS/AGSGeoElement.h>
31 #import <ArcGIS/AGSArcadeProfile.h>
32 
33 
34 
36 @class AGSArcadeExpression;
37 @class AGSFeatureTable;
38 
84 
85 #pragma mark -
86 #pragma mark initializers
87 
88 
89 
95 - (instancetype)initWithExpression:(AGSArcadeExpression *)expression
96  profile:(AGSArcadeProfile)profile;
97 
103 + (instancetype)arcadeEvaluatorWithExpression:(AGSArcadeExpression *)expression
104  profile:(AGSArcadeProfile)profile;
105 
106 #pragma mark -
107 #pragma mark properties
108 
112 @property (nonatomic, strong, readonly) AGSArcadeExpression *expression;
113 
117 @property (nonatomic, copy, readonly) NSArray<NSString *> *profileVariablesUsed;
118 
122 @property (nonatomic, assign, readonly) AGSArcadeProfile profile;
123 
139 @property (nonatomic, assign, readonly, getter=isStable) BOOL stable;
140 
141 #pragma mark -
142 #pragma mark methods
143 
156 - (id<AGSCancelable>)attributesWithVariableName:(NSString *)variableName
157  featureTableSource:(AGSFeatureTable *)featureTableSource
158  completion:(void(^)(NSArray<NSString *> * __nullable result, NSError * __nullable error))completion;
159 
172 - (id<AGSCancelable>)attributesWithVariableName:(NSString *)variableName
173  geoElementSource:(id<AGSGeoElement>)geoElementSource
174  completion:(void(^)(NSArray<NSString *> * __nullable result, NSError * __nullable error))completion;
175 
211 - (id<AGSCancelable>)evaluateWithProfileVariables:(NSDictionary<NSString *, id> *)profileVariables
212  completion:(void(^)(AGSArcadeEvaluationResult * __nullable result, NSError * __nullable error))completion;
213 
214 @end
215 
216 
AGSArcadeProfile
Definition: AGSArcadeProfile.h:47
The result from the successful evaluation of an Arcade Expression.
Definition: AGSArcadeEvaluationResult.h:38
This object allows you to evaluate an AGSArcadeExpression under a given AGSArcadeProfile.
Definition: AGSArcadeEvaluator.h:84
NSArray< NSString * > * profileVariablesUsed
Definition: AGSArcadeEvaluator.h:117
AGSArcadeProfile profile
Definition: AGSArcadeEvaluator.h:122
AGSArcadeExpression * expression
Definition: AGSArcadeEvaluator.h:112
BOOL stable
Definition: AGSArcadeEvaluator.h:139
An Arcade expression object, containing an expression, a name, a return type and a title.
Definition: AGSArcadeExpression.h:53
A source for dataset containing geographic features or non-spatial records.
Definition: AGSFeatureTable.h:65
A base class for loadables.
Definition: AGSLoadableBase.h:45
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
An abstract representation of geographic entities on a map.
Definition: AGSGeoElement.h:43