AGSGPMessage Class Reference


Description

Instances of this class represent messages generated during the execution of a geoprocessing task. They include information such as when the task started, what parameter values are being used, the progress of the task, warnings of potential problems, and errors.

Defined in:
AGSGeoprocessor.h ( ArcGIS library)
Since:
1.0
Inheritance diagram for AGSGPMessage:
<AGSCoding>

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithJSON:

Properties

NSString * description
AGSGPMessageType type

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

Property Documentation

- (NSString*) description [read, copy]

A description of the geoprocessing message.

Since:
1.0
- (AGSGPMessageType) type [read, assign]

The message type. Possible types include

  • AGSGPMessageTypeInformative
  • AGSGPMessageTypeProcessDefinition
  • AGSGPMessageTypeStart
  • AGSGPMessageTypeStop
  • AGSGPMessageTypeWarning
  • AGSGPMessageTypeError
  • AGSGPMessageTypeEmpty
  • AGSGPMessageTypeAbort
Since:
1.0