AGSMapServiceInfo Class Reference

Description

Instances of this class represent information about an ArcGIS Server map service.

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

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithJSON:
(id) - initWithJSON:URL:credential:
(id) - initWithURL:credential:error:
(id) - initWithURL:error:
(NSOperation *) - retrieveLegendInfo

Static Public Member Functions

(id) + mapServiceInfoWithURL:credential:error:
(id) + mapServiceInfoWithURL:error:

Properties

NSString * copyright
AGSCredential * credential
id< AGSMapServiceInfoDelegate > delegate
AGSEnvelope * fullEnvelope
AGSEnvelope * initialEnvelope
NSArray * layerInfos
NSString * serviceDescription
BOOL singleFusedMapCache
AGSSpatialReference * spatialReference
NSArray * tableInfos
AGSTileInfo * tileInfo
AGSTimeInfo * timeInfo
AGSUnits units
NSURL * URL
float version

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) initWithJSON: (NSDictionary *)  json
URL: (NSURL *)  url
credential: (AGSCredential *)  credential 

For completeness, this is to be used when you have a raw dictionary from the REST endpoint.

Parameters:
json The JSON dictionary to initialize the map service info.
url URL to initialize the map service info.
credential AGSCredential used to access secure service.
Returns:
A new, autoreleased, map service info object.
Since:
2.0
- (id) initWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred
error: (NSError **)  error 

Initialize with URL to an ArcGIS Server map service. This will synchronously request the service info from the URL.

Parameters:
url URL pointing to a map service.
cred AGSCredential used to access secure service.
error Information returned in the event the object could not be initialized.
Returns:
A new map service info object.
Since:
1.0
- (id) initWithURL: (NSURL *)  url
error: (NSError **)  error 

Initialize with URL to an ArcGIS Server map service. This will synchronously request the service info from the URL.

Parameters:
url URL pointing to a map service.
error Information returned in the event the object could not be initialized.
Returns:
A new map service info object.
Since:
1.0
+ (id) mapServiceInfoWithURL: (NSURL *)  url
credential: (AGSCredential *)  cred
error: (NSError **)  error 

Initialize autoreleased map service info with URL to an ArcGIS Server map service. This will synchronously request the service info from the URL.

Parameters:
url URL pointing to a map service.
cred AGSCredential used to access secure service.
error Information returned in the event the object could not be initialized.
Returns:
A new, autoreleased, map service info object.
Since:
1.0
+ (id) mapServiceInfoWithURL: (NSURL *)  url
error: (NSError **)  error 

Initialize autoreleased map service info with URL to an ArcGIS Server map service. This will synchronously request the service info from the URL.

Parameters:
url URL pointing to a map service.
error Information returned in the event the object could not be initialized.
Returns:
A new, autoreleased, map service info object.
Since:
1.0
- (NSOperation*) retrieveLegendInfo  

Asynchronously retrieves the legend information for all the layer infos. The delegate is informed when the operation completes successfully or encounters an error.

Availability:
This feature is only available with services from ArcGIS Server 10 Service Pack 1 or above
Since:
1.8
See also:
Conceptual Doc: Displaying Map Legend
Sample: Legend

Property Documentation

- (NSString*) copyright [read, copy]

Copyright text as defined by the map service.

Since:
1.0
- (AGSCredential*) credential [read, copy]

Credential used to access a secured resource

Since:
1.0
- (id<AGSMapServiceInfoDelegate>) delegate [read, write, assign]

The delegate that is notified when asynchronous operations for this map service info complete.

Since:
1.8
- (AGSEnvelope*) fullEnvelope [read, retain]

Full extent of the map service.

Since:
1.0
- (AGSEnvelope*) initialEnvelope [read, retain]

Initial extent of the map service.

Since:
1.0
- (NSArray*) layerInfos [read, retain]

Available layers in the map service and their default visibility as an array of AGSMapServiceLayerInfo objects.

Since:
1.0
- (NSString*) serviceDescription [read, copy]

Map description as defined by the map service.

Since:
1.0
- (BOOL) singleFusedMapCache [read, assign]

Indicates whether the map service is cached.

Since:
1.0
- (AGSSpatialReference*) spatialReference [read, retain]

The spatial reference of the map service.

Since:
1.0
- (NSArray*) tableInfos [read, retain]

Available tables in the map service as an array of AGSMapServiceTableInfo objects.

Since:
1.8
- (AGSTileInfo*) tileInfo [read, retain]

Tiling scheme of the map service. Only applicable if the map service is cached.

Since:
1.0
- (AGSTimeInfo*) timeInfo [read, retain]

Time information for the layer, such as start time field, end time field, track id field, layers time extent and the draw time interval. Only applicable if the layer is time aware.

Since:
1.0
- (AGSUnits) units [read, assign]

The units the map service is in. Possible values include

  • AGSUnitsCentimeters
  • AGSUnitsDecimalDegrees
  • AGSUnitsDecimeters
  • AGSUnitsFeet
  • AGSUnitsInches
  • AGSUnitsKilometers
  • AGSUnitsMeters
  • AGSUnitsMiles
  • AGSUnitsMillimeters
  • AGSUnitsNauticalMiles
  • AGSUnitsPoints
  • AGSUnitsUnknown
  • AGSUnitsYards
Since:
1.0
- (NSURL*) URL [read, copy]

URL of a map service resource in ArcGIS Server REST Services Directory.

Since:
1.0
- (float) version [read, assign]

The version of the server.

Since:
1.8
Copyright © 1995-2011 Esri. All rights reserved.