ArcGIS Runtime SDK for iOS
100.15
|
A mosaic dataset raster.
An instance of this class represents a mosaic dataset raster. A mosaic dataset allows you to store, manage, view, and query collections of raster and image data. It is a data model within the geodatabase used to manage a collection of raster datasets (images) stored as a catalog and viewed as a mosaicked image. Mosaic datasets have advanced raster querying capabilities and processing functions.
A mosaic dataset is created in a geodatabase and can have raster datasets added to it directly. The raster data in a mosaic dataset does not have to be adjoining or overlapping but can exist as unconnected, discontinuous datasets. For example, you can have images that completely cover an area or you can have many strips of images that may not join together to form a continuous image (such as along pipelines).
A mosaic dataset raster can be displayed on screen in a 2D map or a 3D scene using an AGSRasterLayer
.
Instance Methods | |
(id< AGSCancelable >) | - addRasters:completion: |
(void) | - cancelLoad |
(void) | - doCancelLoading |
(void) | - doStartLoading: |
(instancetype) | - initWithFileURL: |
(instancetype) | - initWithFileURL:name: |
(instancetype) | - initWithName:extension: |
(instancetype) | - initWithRasterFunction: |
(void) | - loadDidFinishWithError: |
(void) | - loadWithCompletion: |
(void) | - onLoadStatusChanged |
(void) | - retryLoadWithCompletion: |
Class Methods | |
(AGSMosaicDatasetRaster *) | + createMosaicDatasetRasterWithDatabaseAtFileURL:name:spatialReference: |
(AGSMosaicDatasetRaster *) | + createMosaicDatasetRasterWithGeodatabase:name:spatialReference: |
(NSArray< NSString * > *) | + mosaicDatasetRasterNamesFromDatabaseAtFileURL: |
(instancetype) | + mosaicDatasetRasterWithFileURL:name: |
(instancetype) | + rasterWithFileURL: |
(instancetype) | + rasterWithName:extension: |
(instancetype) | + rasterWithRasterFunction: |
(void) | + removeMosaicDatasetRasterWithName:fromGeodatabase: |
Properties | |
NSURL * | fileURL |
AGSRasterFunction * | function |
NSError * | loadError |
AGSLoadStatus | loadStatus |
- (id<AGSCancelable>) addRasters: | (AGSAddRastersParameters *) | parameters | |
completion: | (nullable void(^)(NSError *__nullable error)) | completion | |
Add individual rasters to the mosaic dataset raster
parameters | specifiying which rasters to add |
completion | block that is invoked when the operation completes. The error is populated only if the operation fails. |
|
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
+ (AGSMosaicDatasetRaster *) createMosaicDatasetRasterWithDatabaseAtFileURL: | (NSURL *) | fileURL | |
name: | (NSString *) | name | |
spatialReference: | (AGSSpatialReference *) | spatialReference | |
Create a new mosaic dataset raster
fileURL | to the geodatabase in which the new mosaic dataset raster needs to be created |
name | of the new mosaic dataset raster to be created |
spatialReference | of the new mosaic dataset raster to be created |
+ (AGSMosaicDatasetRaster *) createMosaicDatasetRasterWithGeodatabase: | (AGSGeodatabase *) | geodatabase | |
name: | (NSString *) | name | |
spatialReference: | (AGSSpatialReference *) | spatialReference | |
Create a new mosaic dataset raster
geodatabase | in which the new mosaic dataset raster needs to be created |
name | of the new mosaic dataset raster to be created |
spatialReference | of the new mosaic dataset raster to be created |
- (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
.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (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.
retrying | flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p) . |
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (instancetype) initWithFileURL: | (NSURL *) | fileURL | |
name: | (NSString *) | name | |
Initialize a mosaic dataset raster using the provided details
fileURL | to the geodatabase containing the mosaic dataset |
name | of the mosaic dataset within the geodatabase |
- (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.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
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.
completion | block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load. |
- cancelLoad
to cancel loading - retryLoadWithCompletion:
to force reload + (NSArray<NSString*> *) mosaicDatasetRasterNamesFromDatabaseAtFileURL: | (NSURL *) | fileURL |
Returns a list of mosaic dataset rasters in the given geodatabase
fileURL | to the geodatabase |
+ (instancetype) mosaicDatasetRasterWithFileURL: | (NSURL *) | fileURL | |
name: | (NSString *) | name | |
Initialize a mosaic dataset raster using the provided details
fileURL | to the geodatabase containing the mosaic dataset |
name | of the mosaic dataset within the geodatabase |
- (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.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
+ (void) removeMosaicDatasetRasterWithName: | (NSString *) | name | |
fromGeodatabase: | (AGSGeodatabase *) | geodatabase | |
Remove the specified mosaic dataset raster from the geodatabase
name | of the mosaic dataset raster to remove |
geodatabase | from which to remove the mosaic dataset raster |
|
requiredinherited |
Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:
cancelLoad
and then this methodIf 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.
completion | block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load. |
|
readnonatomicstronginherited |
File URL to the local raster dataset on disk
|
readnonatomicstronginherited |
A function to transform the raster
|
readnonatomicstronginherited |
The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.
|
readrequirednonatomicassigninherited |
Status of the load operation.