ArcGIS Runtime SDK for iOS: AGSArcGISTiledElevationSource Class Reference
ArcGIS Runtime SDK for iOS  100.11
AGSArcGISTiledElevationSource Class Reference

Description

An elevation source based on tiled elevation data.

Instances of this class represent an elevation source based on a tiled ArcGIS Image Service containing elevation data. It can be used in AGSSurface::elevationSources to specify the surface of a scene.

Since
100
See also
AGSScene::baseSurface to specify the surface of a scene
Inheritance diagram for AGSArcGISTiledElevationSource:
AGSElevationSource <AGSRemoteResource> AGSLoadableBase AGSObject <AGSLoadable>

Instance Methods

(void) - cancelLoad
 
(void) - doCancelLoading
 
(void) - doStartLoading:
 
(instancetype) - initWithItem:
 
(instancetype) - initWithName:
 
(instancetype) - initWithTileCache:
 
(instancetype) - initWithURL:
 
(void) - loadDidFinishWithError:
 
(void) - loadWithCompletion:
 
(void) - onLoadStatusChanged
 
(void) - retryLoadWithCompletion:
 

Class Methods

(instancetype) + ArcGISTiledElevationSource
 
(instancetype) + ArcGISTiledElevationSourceWithItem:
 
(instancetype) + ArcGISTiledElevationSourceWithName:
 
(instancetype) + ArcGISTiledElevationSourceWithTileCache:
 
(instancetype) + ArcGISTiledElevationSourceWithURL:
 

Properties

AGSCredentialcredential
 
BOOL enabled
 
AGSItemitem
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
NSString * name
 
AGSRequestConfigurationrequestConfiguration
 
AGSTileCachetileCache
 
NSURL * URL
 

Method Documentation

◆ ArcGISTiledElevationSource

+ (instancetype) ArcGISTiledElevationSource

Initialize a tiled elevation source.

Since
100

◆ ArcGISTiledElevationSourceWithItem:

+ (instancetype) ArcGISTiledElevationSourceWithItem: (AGSItem *)  item

Initialize a tiled elevation source based on an item on ArcGIS Online or ArcGIS Portal representing an ArcGIS Image service containing elevation data.

Parameters
itemrepresenting an ArcGIS Image service containing elevation data.
Returns
A new tiled elevation source
Since
100

◆ ArcGISTiledElevationSourceWithName:

+ (instancetype) ArcGISTiledElevationSourceWithName: (NSString *)  name

Initialize a tiled elevation source with the name of a local Tile Package (.tpk or .tpkx file) within the application bundle or shared documents directory containing elevation data.

Parameters
nameThe name of a local Tile Package (same as the name of the .tpk or .tpkx file without the file extension) containing elevation data.
Returns
A new tiled elevation source.
Since
100.1

◆ ArcGISTiledElevationSourceWithTileCache:

+ (instancetype) ArcGISTiledElevationSourceWithTileCache: (AGSTileCache *)  tileCache

Initialize a tiled elevation source based on an tile cache containing elevation data.

Parameters
tileCachecontaining elevation data.
Returns
A new tiled elevation source
Since
100.1

◆ ArcGISTiledElevationSourceWithURL:

+ (instancetype) ArcGISTiledElevationSourceWithURL: (NSURL *)  URL

Initialize a tiled elevation source based on an ArcGIS Image service or a local Tile Package (.tpk or .tpkx file) on disk containing elevation data.

Parameters
URLThe URL to a tiled ArcGIS Image service or a local Tile Package (.tpk or .tpkx file) on disk containing elevation data.
Returns
A new tiled elevation source.
Since
100

◆ cancelLoad

- (void) cancelLoad
requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since
100

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL)  retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters
retryingflag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).
Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ initWithItem:

- (instancetype) initWithItem: (AGSItem *)  item

Initialize a tiled elevation source based on an item on ArcGIS Online or ArcGIS Portal representing an ArcGIS Image service containing elevation data.

Parameters
itemrepresenting an ArcGIS Image service containing elevation data.
Returns
A new tiled elevation source
Since
100

◆ initWithName:

- (instancetype) initWithName: (NSString *)  name

Initialize a tiled elevation source with the name of a local Tile Package (.tpk or .tpkx file) within the application bundle or shared documents directory containing elevation data.

Parameters
nameThe name of a local Tile Package (same as the name of the .tpk or .tpkx file without the file extension) containing elevation data.
Returns
A new tiled elevation source
Since
100.1

◆ initWithTileCache:

- (instancetype) initWithTileCache: (AGSTileCache *)  tileCache

Initialize a tiled elevation source based on an tile cache containing elevation data.

Parameters
tileCachecontaining elevation data.
Returns
A new tiled elevation source
Since
100.1

◆ initWithURL:

- (instancetype) initWithURL: (NSURL *)  URL

Initialize a tiled elevation source based on an ArcGIS Image service or a local Tile Package (.tpk or .tpkx file) on disk containing elevation data.

Parameters
URLThe URL to a tiled ArcGIS Image service or a local Tile Package (.tpk or .tpkx file) on disk containing elevation data.
Returns
A new tiled elevation source.
Since
100

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *)  error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100
See also
- cancelLoad to cancel loading
- retryLoadWithCompletion: to force reload

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

  1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
  2. the server was down earlier when it failed and you want to retry
  3. the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100

Property Documentation

◆ credential

- (AGSCredential*) credential
readwritenonatomicstronginherited

Security credentials to access the remote resource. Only applicable if the resource is secured.

Since
100

◆ enabled

- (BOOL) enabled
readwritenonatomicassigninherited

Indicates whether this elevation source is enabled or not

Since
100

◆ item

- (AGSItem*) item
readnonatomicstrong

The item being used by the elevation source, if any.

Since
100

◆ loadError

- (NSError*) loadError
readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since
100

◆ loadStatus

- (AGSLoadStatus) loadStatus
readrequirednonatomicassigninherited

Status of the load operation.

Since
100

◆ name

- (NSString*) name
readwritenonatomiccopyinherited

Name of the elevation source

Since
100

◆ requestConfiguration

- (AGSRequestConfiguration*) requestConfiguration
readwritenonatomicstronginherited

The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.

Since
100

◆ tileCache

- (AGSTileCache*) tileCache
readnonatomicstrong

The tile cache being used by the elevation source, if any.

Since
100.1

◆ URL

- (NSURL*) URL
readrequirednonatomicstronginherited

The URL of the remote resource.

Since
100