AGSGPParameterValue Class Reference

---

Description

Instances of this class respresent input/output parameters of a geoprocessing task.

Defined in:

AGSGeoprocessor.h ( ArcGIS library)

Since:

1.0

Inheritance diagram for AGSGPParameterValue:

List of all members.

Public Member Functions
(void)	- decodeWithJSON:
(NSDictionary *)	- encodeToJSON
(id)	- initWithJSON:
(id)	- initWithName:type:value:
Static Public Member Functions
(id)	+ parameterWithName:type:value:
Properties
NSString *	name
AGSGPParameterType	type
id	value

---

Member Function Documentation

- (void) decodeWithJSON:

(NSDictionary *)

json

[optional, inherited]

Decode object from JSON representation.

Parameters:

json

The JSON representation of the object to be decoded.

Since:

1.0

- (NSDictionary *) encodeToJSON

[optional, inherited]

Encode and return JSON representation for object.

Returns:

JSON representation of object.

Since:

1.0

- (id) initWithJSON:

(NSDictionary *)

json

[optional, inherited]

Initialize and return object from JSON representation.

Parameters:

json

The JSON representation of the object to be created.

Returns:

Object decoded from JSON representation.

Since:

1.0

- (id) initWithName:		(NSString *)	name
type:		(AGSGPParameterType)	type
value:		(id)	value

Initialize an AGSGPParameterValue object.

Parameters:

	name	The name of the parameter.
	type	The type of the parameter.
	value	The value of the parameter.

Returns:

A new geoprocessing parameter object.

Since:

1.0

+ (id) parameterWithName:		(NSString *)	name
type:		(AGSGPParameterType)	type
value:		(id)	value

Initialize an AGSGPParameterValue object.

Parameters:

	name	The name of the parameter.
	type	The type of the parameter.
	value	The value of the parameter.

Returns:

A new, autoreleased, geoprocessing parameter object.

Since:

1.0

---

Property Documentation

- (NSString*) name [read, copy]

Name of the parameter.

Since:

1.0

- (AGSGPParameterType) type [read, assign]

Data type of the parameter. Possible types include

• AGSGPParameterTypeBoolean
• AGSGPParameterTypeDouble
• AGSGPParameterTypeLong
• AGSGPParameterTypeString
• AGSGPParameterTypeLinearUnit
• AGSGPParameterTypeFeatureRecordSetLayer
• AGSGPParameterTypeRecordSet
• AGSGPParameterTypeDataFile
• AGSGPParameterTypeDate
• AGSGPParameterTypeRasterData
• AGSGPParameterTypeRasterDataLayer
• AGSGPParameterTypeMultiValue

Since:

1.0

- (id) value [read, retain]

Value of the parameter. The data structure of this value depends on the type.

Type	Value
AGSGPParameterTypeBoolean	NSValue
AGSGPParameterTypeDouble	NSNumber
AGSGPParameterTypeLong	NSNumber
AGSGPParameterTypeString	NSString
AGSGPParameterTypeLinearUnit	AGSGPLinearUnit
AGSGPParameterTypeFeatureRecordSetLayer	AGSFeatureSet
AGSGPParameterTypeRecordSet	AGSFeatureSet
AGSGPParameterTypeDataFile	NSURL
AGSGPParameterTypeDate	NSDate
AGSGPParameterTypeRasterData	AGSGPRasterData
AGSGPParameterTypeRasterDataLayer	AGSGPRasterData
AGSGPParameterTypeMultiValue	NSArray