ArcGIS Runtime SDK for iOS: AGSGeoprocessingParameterInfo.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSGeoprocessingParameterInfo.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 #import <ArcGIS/AGSGeoprocessingTypes.h>
30 
31 
32 
37 typedef NS_ENUM(NSInteger, AGSGeoprocessingParameterDirection) {
40 };
41 
43 
51 
52 #pragma mark -
53 #pragma mark initializers
54 
55 
56 
57 #pragma mark -
58 #pragma mark properties
59 
63 @property (nonatomic, copy, readonly) NSString *category;
64 
68 @property (nonatomic, copy, readonly) NSArray<NSString*> *choiceList;
69 
73 @property (nonatomic, assign, readonly) AGSGeoprocessingParameterType dataType;
74 
78 @property (nullable, nonatomic, strong, readonly) AGSGeoprocessingParameter *defaultParameter;
79 
83 @property (nonatomic, copy, readonly) NSString *parameterDescription;
84 
88 @property (nonatomic, assign, readonly) AGSGeoprocessingParameterDirection direction;
89 
93 @property (nonatomic, copy, readonly) NSString *displayName;
94 
98 @property (nonatomic, assign, readonly) BOOL featuresRequireGeometry;
99 
103 @property (nonatomic, assign, readonly, getter=isRequired) BOOL required;
104 
108 @property (nonatomic, assign, readonly) AGSGeoprocessingParameterType multiValueDataType;
109 
113 @property (nonatomic, copy, readonly) NSString *name;
114 
115 #pragma mark -
116 #pragma mark methods
117 
118 @end
119 
120 
AGSGeoprocessingParameterDirection
Definition: AGSGeoprocessingParameterInfo.h:37
@ AGSGeoprocessingParameterDirectionOutput
Definition: AGSGeoprocessingParameterInfo.h:39
@ AGSGeoprocessingParameterDirectionInput
Definition: AGSGeoprocessingParameterInfo.h:38
AGSGeoprocessingParameterType
Definition: AGSGeoprocessingTypes.h:35
A base class for geoprocessing parameters.
Definition: AGSGeoprocessingParameter.h:38
Information about an input/output Geoprocessing Task parameter.
Definition: AGSGeoprocessingParameterInfo.h:51
AGSGeoprocessingParameter * defaultParameter
Definition: AGSGeoprocessingParameterInfo.h:78
BOOL featuresRequireGeometry
Definition: AGSGeoprocessingParameterInfo.h:98
NSString * parameterDescription
Definition: AGSGeoprocessingParameterInfo.h:83
AGSGeoprocessingParameterType multiValueDataType
Definition: AGSGeoprocessingParameterInfo.h:108
AGSGeoprocessingParameterType dataType
Definition: AGSGeoprocessingParameterInfo.h:73
AGSGeoprocessingParameterDirection direction
Definition: AGSGeoprocessingParameterInfo.h:88
NSString * name
Definition: AGSGeoprocessingParameterInfo.h:113
BOOL required
Definition: AGSGeoprocessingParameterInfo.h:103
NSString * displayName
Definition: AGSGeoprocessingParameterInfo.h:93
NSString * category
Definition: AGSGeoprocessingParameterInfo.h:63
NSArray< NSString * > * choiceList
Definition: AGSGeoprocessingParameterInfo.h:68
Definition: AGSObject.h:28