An ENC Cell.
Instances of this class represent a single ENC (Electronic Navigational Chart) data source.
- Note
AGSENCEnvironmentSettings::SENCDataDirectory
and AGSENCEnvironmentSettings::resourceDirectory
need to be set before ENC data can be used
- Since
- 100.2
- License Restrictions:
- This feature requires a Standard license for production deployment. No license required in Developer mode for testing.
◆ cancelLoad
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
◆ doStartLoading:
- (void) doStartLoading: |
|
(BOOL) |
retrying |
|
◆ ENCCellWithDataset:
Initialize the ENC cell with the provided dataset
- Parameters
-
dataset | retrieved from an ENC exchange set |
- Returns
- Initialized ENC cell
- Since
- 100.2
◆ initWithDataset:
Initialize the ENC cell with the provided dataset
- Parameters
-
dataset | retrieved from an ENC exchange set |
- Returns
- Initialized ENC cell
- Since
- 100.2
◆ loadDidFinishWithError:
- (void) loadDidFinishWithError: |
|
(nullable NSError *) |
error |
|
◆ 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
-
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. |
- 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 |
|
|
|
◆ 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:
- you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
- the server was down earlier when it failed and you want to retry
- 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
-
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. |
- Note
- The completion block is always invoked on the main thread.
- Since
- 100
◆ dataset
The ENC dataset associated with the ENC cell. Only applicable if this cell was initialized with a dataset.
- Since
- 100.2
◆ fileURL
The path to the S-57/ENC (extension .000) file associated with the ENC cell. Only applicable if this cell was initialized with a path.
- Since
- 100.2
◆ loadError
|
readnonatomicstronginherited |
The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.
- Since
- 100
◆ loadStatus
|
readrequirednonatomicassigninherited |
Status of the load operation.
- Since
- 100