ArcGIS Runtime SDK for iOS: AGSHorizontalVerticalTransformationStep Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSHorizontalVerticalTransformationStep Class Reference

Description

Represents a step in the process of transforming between horizontal and/or vertical datums.

Each AGSHorizontalVerticalTransformationStep can be constructed from a well-known ID (WKID) that represents a horizontal (geographic) or a vertical transformation. Runtime supports thousands of predefined transformations, and all the supported WKIDs are documented in the 'Coordinate systems and transformations' topic in the developers guide.

One or more AGSHorizontalVerticalTransformationStep objects are combined into an AGSHorizontalVerticalTransformation object, and can then be used to control how coordinates are transformed in an AGSGeometryEngine::projectWithGeometry:outputSpatialReference:datumTransformation: method call.

An AGSHorizontalVerticalTransformationStep object is immutable.

See also
AGSHorizontalVerticalTransformation, AGSGeographicTransformationStep
Since
100.9
Inheritance diagram for AGSHorizontalVerticalTransformationStep:
AGSObject

Instance Methods

(nullable instancetype) - initWithWKID:
 
(nullable instancetype) - initWithWKText:
 
(nullable AGSHorizontalVerticalTransformationStep *) - inverse
 
(BOOL) - isEqualToHorizontalVerticalTransformationStep:
 

Class Methods

(nullable instancetype) + horizontalVerticalTransformationStepWithWKID:
 
(nullable instancetype) + horizontalVerticalTransformationStepWithWKText:
 

Properties

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

Method Documentation

◆ horizontalVerticalTransformationStepWithWKID:

+ (nullable instancetype) horizontalVerticalTransformationStepWithWKID: (NSInteger)  WKID

Creates a new AGSHorizontalVerticalTransformationStep instance from a well-known ID.

Occasionally, WKIDs may change, and older codes may be deprecated in favor of a new code. Both old (deprecated) and new (latest) WKIDs continue to work for instantiation, as long as they are supported by the Projection Engine. The AGSHorizontalVerticalTransformationStep::WKID property is the new (latest) WKID code.

Parameters
WKIDThe well-known ID of the transformation step to create.
Since
100.9

◆ horizontalVerticalTransformationStepWithWKText:

+ (nullable instancetype) horizontalVerticalTransformationStepWithWKText: (NSString *)  WKText

Creates a new AGSHorizontalVerticalTransformationStep instance from a well-known text string.

Parameters
WKTextThe well-known text of the transformation step to create.
Since
100.9

◆ initWithWKID:

- (nullable instancetype) initWithWKID: (NSInteger)  WKID

Creates a new AGSHorizontalVerticalTransformationStep instance from a well-known ID.

Occasionally, WKIDs may change, and older codes may be deprecated in favor of a new code. Both old (deprecated) and new (latest) WKIDs continue to work for instantiation, as long as they are supported by the Projection Engine. The AGSHorizontalVerticalTransformationStep::WKID property is the new (latest) WKID code.

Parameters
WKIDThe well-known ID of the transformation step to create.
Since
100.9

◆ initWithWKText:

- (nullable instancetype) initWithWKText: (NSString *)  WKText

Creates a new AGSHorizontalVerticalTransformationStep instance from a well-known text string.

Parameters
WKTextThe well-known text of the transformation step to create.
Since
100.9

◆ inverse

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

Returns
An AGSHorizontalVerticalTransformationStep representing the inverse or nil if an inverse doesn't exist.
Since
100.9

◆ isEqualToHorizontalVerticalTransformationStep:

- (BOOL) isEqualToHorizontalVerticalTransformationStep: (AGSHorizontalVerticalTransformationStep *)  other

Returns YES if the two transformation steps are equal, NO otherwise.

Parameters
otherAnother AGSHorizontalVerticalTransformationStep.
Returns
YES if the two transformations are equal, NO otherwise.
Since
100.9

Property Documentation

◆ inverse

- (BOOL) inverse
readnonatomicassign

A Boolean value indicating whether the transformation step is an inverted transformation.

YES if this transformation step instance is an inverted transformation.

Transformations have a specific direction that is indicated by the AGSHorizontalVerticalTransformationStep::WKText value. An inverted transformation is used to transform geometries in the opposite direction to that indicated by the Well-Known Text. AGSHorizontalVerticalTransformationStep has AGSDatumTransformation::inputSpatialReference and AGSDatumTransformation::outputSpatialReference properties that respect the inverse value of the contained transformation(s).

See also
AGSHorizontalVerticalTransformationStep::inverse
Since
100.9

◆ missingProjectionEngineFiles

- (BOOL) missingProjectionEngineFiles
readnonatomicassign

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

Since
100.9

◆ projectionEngineFilenames

- (NSArray<NSString *>*) projectionEngineFilenames
readnonatomiccopy

An array of the Projection Engine files required to support this transformation step.

Each name in the array includes the full path. Projection Engine datasets are used in grid-based transforms.

Since
100.9

◆ WKID

- (NSInteger) WKID
readnonatomicassign

The well-known ID or 0 if the transformation in this step doesn't have a well-known ID.

-1 on error.

Occasionally, WKIDs may change, and an older code may be deprecated in favor of a new code. This property returns the new (latest) WKID code.

Since
100.9

◆ WKText

- (NSString*) WKText
readnonatomiccopy

The well-known text of this transformation step instance.

Since
100.9