AGSGeographicTransformationStep Class Reference

Description

Represents a step in the process of transforming between datums.

Instances of this class represent a step in the process of transforming between datums of spatial references.

Each geographic transformation step can be constructed from a well-known ID (WKID) that represents a geographic transformation. Because the Projection Engine supports thousands of transformations, WKIDs are not presented in the SDK as enumerations. Instead, they are documented in the guide and online. The list of supported WKIDs includes a transformation from every supported datum to WGS 1984. Additionally, there is a more limited list of transformations directly between two non-WGS84 datums, such as 4461, which is NAD_1983_HARN_To_NAD_1983_NSRS2007_1.

Transformations with more than one step typically go via WGS84, with one forward and one inverse geographic transformation chained together to get the required geographic coordinates.

A geographic transformation step object is immutable.

See also

AGSTransformationCatalog to find a list of suitable tranformations between two spatial references

AGSGeographicTransformation, AGSHorizontalVerticalTransformationStep

Since

100.2

Inheritance diagram for AGSGeographicTransformationStep:

Instance Methods
(nullable instancetype)	- initWithWKID:
(nullable instancetype)	- initWithWKText:
(nullable AGSGeographicTransformationStep *)	- inverse
(BOOL)	- isEqualToGeographicTransformationStep:

Class Methods
(nullable instancetype)	+ geographicTransformationStepWithWKID:
(nullable instancetype)	+ geographicTransformationStepWithWKText:

Properties
BOOL	missingProjectionEngineFiles
NSArray< NSString * > *	projectionEngineFilenames
NSInteger	WKID
NSString *	WKText

Method Documentation

geographicTransformationStepWithWKID:()

+ (nullable instancetype) geographicTransformationStepWithWKID:

(NSInteger)

WKID

Initialize this step with the given well known ID of a geographic transformation

Parameters

WKID	well known ID of a geographic transformation

Returns

Initialized geographic transformation step

Since

100.2

geographicTransformationStepWithWKText:()

+ (nullable instancetype) geographicTransformationStepWithWKText:

(NSString *)

WKText

Initialize this step with the given well known text of a geographic transformation

Parameters

WKText

well known text of a geographic transformation

Returns

Initialized geographic transformation step

Since

100.2

initWithWKID:()

- (nullable instancetype) initWithWKID:

(NSInteger)

WKID

Initialize this step with the given well known ID of a geographic transformation

Parameters

WKID	well known ID of a geographic transformation

Returns

Initialized geographic transformation step

Since

100.2

initWithWKText:()

- (nullable instancetype) initWithWKText:

(NSString *)

WKText

Initialize this step with the given well known text of a geographic transformation

Parameters

WKText

well known text of a geographic transformation

Returns

Initialized geographic transformation step

Since

100.2

inverse()

- (nullable AGSGeographicTransformationStep*) inverse

Returns the inverse of this geographic transformation step or NULL if the transformation is not invertible.

Since

100.2

isEqualToGeographicTransformationStep:()

- (BOOL) isEqualToGeographicTransformationStep:

(AGSGeographicTransformationStep *)

other

Returns if this geographic transformation step is equal to the one provided

Parameters

other

step to compare this one to

Since

100.2

Property Documentation

missingProjectionEngineFiles

- (BOOL) missingProjectionEngineFiles

readnonatomicassign

Indicates if any files needed by the Projection Engine for this geographic transformation step are missing from the local file system

Note

In order for the Projection Engine files to be found, their location must be set upon application startup using setProjectionEngineDirectory:error: (AGSTransformationCatalog) before using any other Runtime API.

Since

100.2

projectionEngineFilenames

- (NSArray<NSString*>*) projectionEngineFilenames

readnonatomiccopy

The list of the Projection Engine files required to support this geographic transformation step. Each name in the list includes the full path. Projection Engine datasets are used in grid-based transforms.

Note

In order for the Projection Engine files to be found, their location must be set upon application startup using setProjectionEngineDirectory:error: (AGSTransformationCatalog) before using any other Runtime API.

Since

100.2

WKID

- (NSInteger) WKID

readnonatomicassign

Well Known ID of the geographic transformation

Since

100.2

WKText

- (NSString*) WKText

readnonatomiccopy

Well Known Text of the geographic transformation

Since

100.2