ArcGIS Runtime SDK for iOS: AGSGeoModel Class Reference
ArcGIS Runtime SDK for iOS  100.15
AGSGeoModel Class Reference

Description

A base class for either an AGSMap or an AGSScene.

The base class AGSGeoModel represents the model in a model-view-controller (MVC) architecture, while AGSGeoView represents the view. AGSMap and AGSScene derive from AGSGeoModel.

You provide an AGSGeoModel to the appropriate type of view:

Inheritance diagram for AGSGeoModel:
AGSLoadableBase AGSObject <AGSLoadable> AGSMap AGSScene

Instance Methods

(void) - cancelLoad
 
(void) - doCancelLoading
 
(void) - doStartLoading:
 
(void) - loadDidFinishWithError:
 
(void) - loadWithCompletion:
 
(void) - onLoadStatusChanged
 
(void) - retryLoadWithCompletion:
 

Properties

NSMutableArray< AGSBookmark * > * bookmarks
 
AGSGeoModelFloorDefinitionfloorDefinition
 
AGSFloorManagerfloorManager
 
AGSGeotriggersInfogeotriggersInfo
 
AGSItemitem
 
NSError * loadError
 
AGSLoadSettingsloadSettings
 
AGSLoadStatus loadStatus
 
NSMutableArray< AGSLayer * > * operationalLayers
 
AGSSpatialReferencespatialReference
 
NSMutableArray< AGSFeatureTable * > * tables
 
NSArray< AGSTransportationNetworkDataset * > * transportationNetworks
 
NSString * version
 

Method Documentation

◆ 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).

◆ 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

◆ bookmarks

- (NSMutableArray<AGSBookmark *>*) bookmarks
readnonatomicstrong

The bookmarks for the map or scene.

See also
AGSBookmark
Since
100.12

◆ floorDefinition

- (AGSGeoModelFloorDefinition*) floorDefinition
readwritenonatomicstrong

Defines the properties that allow a map or a scene to be floor-aware.

Floor-aware maps and scenes contain data representing floor plan and indoor features. The data displayed by floor-aware maps and scenes can be filtered based on floor levels using the AGSFloorManager. This property is nil for maps or scenes that are not floor-aware. When this property is set, a new unloaded AGSGeoModel::floorManager is instantiated.

See also
AGSGeoModel::floorManager
Since
100.12

◆ floorManager

- (AGSFloorManager*) floorManager
readnonatomicstrong

Manages the data displayed for a floor-aware map or scene, allowing the data to be filtered based on floor levels.

This property is created using the floor-aware metadata defined by AGSGeoModel::floorDefinition, if not nil. This property is nil if the map/scene is not loaded or if the map/scene is not floor-aware. An AGSFloorManager must be loaded before you can access its properties and perform floor filtering.

See also
AGSFloorManager
Since
100.12

◆ geotriggersInfo

- (AGSGeotriggersInfo*) geotriggersInfo
readnonatomicstrong

An object that presents information on the set of AGSGeotrigger objects defined for the map or scene.

You must load the AGSGeotriggersInfo to populate the AGSGeotriggersInfo::geotriggers defined by the author of the map or scene. If no geotriggers were defined, the the collection will be empty.

Use an AGSGeotriggerMonitor to check each of the conditions defined in AGSGeotriggersInfo::geotriggers.

When you save the map, any AGSGeotrigger objects that reference local data (for example an AGSGraphicsOverlayFenceParameters) will be omitted.

Since
100.14

◆ item

- (AGSItem*) item
readnonatomicstrong

The item for the map or scene.

An ID for a resource, such as an AGSPortalItem (for maps created from a portal) or an AGSLocalItem (for maps and scenes in a map or scene package). Note that a map or scene cannot be instantiated from an AGSLocalItem.

Since
100.12

◆ loadError

- (NSError*) loadError
readnonatomicstronginherited

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

Since
100

◆ loadSettings

- (AGSLoadSettings*) loadSettings
readwritenonatomicstrong

Set default behaviors (preferences) and control the rendering behaviors for maps and scenes as they load.

Set preferences and control rendering behaviors when maps and scenes load. For example, you can specify which tiling mode should be used when feature layers are added or specify whether feature tables should use advanced symbology.

Since
100.12

◆ loadStatus

- (AGSLoadStatus) loadStatus
readrequirednonatomicassigninherited

Status of the load operation.

Since
100

◆ operationalLayers

- (NSMutableArray<AGSLayer *>*) operationalLayers
readnonatomicstrong

Layers that reference data from a file or a service and are typically used to visualize the data in a map or scene. For example, a fleet of vehicles being tracked on a map.

Operational layers, which display on top of the AGSBasemap::baseLayers property, are hosted and managed on the ArcGIS Platform as feature layers, KML layers, WFS layers, tile layers, and more. Several layer types can also be used by your ArcGIS Runtime app as local layers, such as feature layers and tiled layers. You cannot reuse a layer array coming from a different map or scene. Instead, you must create a new array of AGSLayer objects.

See also
AGSLayer, AGSBasemap::baseLayers
Since
100.12

◆ spatialReference

- (AGSSpatialReference*) spatialReference
readnonatomicstrong

A well-known ID (WKID) integer value or a text string definition referred to as a well-known text (WKT) representation that identifies how a geometry's coordinates relate to real-world space.

Spatial reference ensures that spatial data in different layers or graphic overlays can be used together for accurate viewing or analysis.

See also
AGSSpatialReference
Since
100.12

◆ tables

- (NSMutableArray<AGSFeatureTable *>*) tables
readnonatomicstrong

An array of tables in the map or scene. Unlike AGSGeoModel::operationalLayers, tables are not displayed by the AGSGeoView.

Tables can be added and removed. Tables are not loaded by default. Tables are loaded internally when asynchronous operations like query are performed. Alternatively, they can be loaded by calling AGSFeatureTable::load.

See also
AGSFeatureTable, NSMutableArray, NSMutableArray::initWithValueType:
Since
100.12

◆ transportationNetworks

- (NSArray<AGSTransportationNetworkDataset *>*) transportationNetworks
readnonatomiccopy

An array of transportation network datasets defined for the map or scene.

Map and scene authors can use ArcGIS Pro to create mobile map or scene packages containing maps and scenes that include transportation networks. If so, this property will be populated with the collection of AGSTransportationNetworkDataset objects.

An AGSTransportationNetworkDataset from this array can be used to construct one of the network analysis tasks (such as AGSRouteTask, AGSServiceAreaTask, and AGSClosestFacilityTask).

See also
AGSRouteTask, AGSMobileScenePackage
Since
100.12

◆ version

- (NSString*) version
readnonatomiccopy

The version of the AGSMap or AGSScene, read when it is opened.

The version of a newly created AGSMap or AGSScene is empty. The version that the map or scene is saved to might differ from the version it was opened at. The version saved depends on the ArcGIS Runtime version.

Since
100.12