AGSGeoModelFloorDefinition Class Reference

Description

Contains floor-awareness settings for a map or scene.

AGSGeoModelFloorDefinition defines the required layers, and the required fields for each of those layers in a floor-aware map or scene. The floor definition must contain AGSGeoModelFloorDefinition::levelLayerDefinition and AGSGeoModelFloorDefinition::facilityLayerDefinition properties at a minimum representing the facilities (eg. buildings) and the floor levels within those facilities. The AGSGeoModelFloorDefinition::siteLayerDefinition property is optional, and represents the sites (campuses) that the facilities may be grouped into.

See also

AGSLayerFloorDefinition

Since

100.12

Inheritance diagram for AGSGeoModelFloorDefinition:

Instance Methods
(instancetype)	- initWithFacilityLayerDefinition:levelLayerDefinition:siteLayerDefinition:
(nullable id)	- toJSON:

Class Methods
(nullable id< AGSJSONSerializable >)	+ fromJSON:error:
(instancetype)	+ geoModelFloorDefinitionWithFacilityLayerDefinition:levelLayerDefinition:siteLayerDefinition:

Properties
AGSFacilityLayerDefinition *	facilityLayerDefinition
AGSLevelLayerDefinition *	levelLayerDefinition
AGSSiteLayerDefinition *	siteLayerDefinition
NSDictionary< NSString *, id > *	unknownJSON
NSDictionary< NSString *, id > *	unsupportedJSON

Method Documentation

fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject error: (NSError **)  error

staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters

JSONObject	NSDictionary or NSArray containing the JSON.
error	encountered during the operation, if any.

Since

100

geoModelFloorDefinitionWithFacilityLayerDefinition:levelLayerDefinition:siteLayerDefinition:

+ (instancetype) geoModelFloorDefinitionWithFacilityLayerDefinition:		(AGSFacilityLayerDefinition *)	facilityLayerDefinition
levelLayerDefinition:		(AGSLevelLayerDefinition *)	levelLayerDefinition
siteLayerDefinition:		(nullable AGSSiteLayerDefinition *)	siteLayerDefinition

Creates a new AGSGeoModelFloorDefinition object with the provided arguments.

Parameters

facilityLayerDefinition	The layer and field properties for the layer used to describe facilities.
levelLayerDefinition	The layer and field properties for the layer used to describe floor levels.
siteLayerDefinition	The layer and field properties for the layer used to describe sites.

Since

100.12

initWithFacilityLayerDefinition:levelLayerDefinition:siteLayerDefinition:

- (instancetype) initWithFacilityLayerDefinition:		(AGSFacilityLayerDefinition *)	facilityLayerDefinition
levelLayerDefinition:		(AGSLevelLayerDefinition *)	levelLayerDefinition
siteLayerDefinition:		(nullable AGSSiteLayerDefinition *)	siteLayerDefinition

Creates a new AGSGeoModelFloorDefinition object with the provided arguments.

Parameters

facilityLayerDefinition	The layer and field properties for the layer used to describe facilities.
levelLayerDefinition	The layer and field properties for the layer used to describe floor levels.
siteLayerDefinition	The layer and field properties for the layer used to describe sites.

Since

100.12

toJSON:

- (nullable id) toJSON: (NSError **)  error

requiredinherited

Returns JSON representation for this object.

Parameters

error

encountered during the operation, if any.

Returns

NSDictionary or NSArray containing the JSON.

Since

100

Reimplemented in AGSPortalItem.

Property Documentation

facilityLayerDefinition

- (AGSFacilityLayerDefinition*) facilityLayerDefinition

readnonatomicstrong

The layer and field properties for the layer used to describe facilities.

Since

100.12

levelLayerDefinition

- (AGSLevelLayerDefinition*) levelLayerDefinition

readnonatomicstrong

The layer and field properties for the layer used to describe floor levels.

Since

100.12

siteLayerDefinition

- (AGSSiteLayerDefinition*) siteLayerDefinition

readnonatomicstrong

The layer and field properties for the layer used to describe sites. This property is optional.

Since

100.12

unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON

readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns

NSDictionary containing the unknown JSON.

Since

100

unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON

readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns

NSDictionary containing the unsupported JSON.

Since

100