Skip To Content ArcGIS for Developers Sign In Dashboard

HorizontalVerticalTransformationStep Class

class Esri::ArcGISRuntime::HorizontalVerticalTransformationStep

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

Header: #include <HorizontalVerticalTransformationStep>
Since: Esri::ArcGISRuntime 100.9

This class was introduced in Esri::ArcGISRuntime 100.9.

Public Functions

HorizontalVerticalTransformationStep(Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &&other)
HorizontalVerticalTransformationStep(const Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &other)
HorizontalVerticalTransformationStep(const QString &wkText)
HorizontalVerticalTransformationStep(int wkid)
HorizontalVerticalTransformationStep()
Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &operator=(Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &&other)
Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &operator=(const Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &other)
~HorizontalVerticalTransformationStep()
Esri::ArcGISRuntime::HorizontalVerticalTransformationStep inverseTransformation() const
bool isEmpty() const
bool isInverse() const
bool isMissingProjectionEngineFiles() const
QStringList projectionEngineFilenames() const
QString wkText() const
int wkid() const
bool operator!=(const Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &other) const
bool operator==(const Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &other) const

Detailed Description

Each HorizontalVerticalTransformationStep can be constructed from a well-known ID (WKID) that represents a horizontal (horizontal-vertical) 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 HorizontalVerticalTransformationStep objects are combined into a HorizontalVerticalTransformation object, and can then be used to control how coordinates are transformed in a GeometryEngine::project(const Esri::ArcGISRuntime::Geometry&, const Esri::ArcGISRuntime::SpatialReference&, Esri::ArcGISRuntime::DatumTransformation*) method call.

A HorizontalVerticalTransformationStep object is immutable.

See also HorizontalVerticalTransformation and GeographicTransformationStep.

Member Function Documentation

HorizontalVerticalTransformationStep::HorizontalVerticalTransformationStep(Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &&other)

Move constructor from other HorizontalVerticalTransformationStep.

HorizontalVerticalTransformationStep::HorizontalVerticalTransformationStep(const Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &other)

Copy constructor from other HorizontalVerticalTransformationStep.

HorizontalVerticalTransformationStep::HorizontalVerticalTransformationStep(const QString &wkText)

Constructor that accepts the WKT (wkText) for the horizontal-vertical transformation.

Use this constructor to specify a custom transformation, using WKT notation.

HorizontalVerticalTransformationStep::HorizontalVerticalTransformationStep(int wkid)

Constructor that accepts the WKID (wkid) for the horizontal-vertical transformation.

HorizontalVerticalTransformationStep::HorizontalVerticalTransformationStep()

Default constructor.

Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &HorizontalVerticalTransformationStep::operator=(Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &&other)

Move operator from other HorizontalVerticalTransformationStep.

Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &HorizontalVerticalTransformationStep::operator=(const Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &other)

Assignment operator from other HorizontalVerticalTransformationStep.

HorizontalVerticalTransformationStep::~HorizontalVerticalTransformationStep()

Destructor.

Esri::ArcGISRuntime::HorizontalVerticalTransformationStep HorizontalVerticalTransformationStep::inverseTransformation() const

Returns a HorizontalVerticalTransformationStep that is the inverse of this HorizontalVerticalTransformationStep.

Returns empty HorizontalVerticalTransformationStep if there is no inverse of this HorizontalVerticalTransformationStep.

bool HorizontalVerticalTransformationStep::isEmpty() const

Returns true if this horizontal-vertical transformation step is empty.

bool HorizontalVerticalTransformationStep::isInverse() const

Returns whether this horizontal-vertical transformation step instance is an inverted transformation.

Returns true if this step uses the inverse of the horizontal-vertical transformation contained in this step.

If this transformation step is empty, returns false.

bool HorizontalVerticalTransformationStep::isMissingProjectionEngineFiles() const

Returns whether any files needed by the Projection Engine for this HorizontalVerticalTransformationStep are missing from the local file system.

Return value is meaningless if transformation step is empty.

QStringList HorizontalVerticalTransformationStep::projectionEngineFilenames() const

Returns a list of the Projection Engine files required to support this step.

Each name in the list includes the full path.

Projection Engine datasets are used in grid-based transforms.

QString HorizontalVerticalTransformationStep::wkText() const

Returns the Well-Known Text (WKT) representation of the horizontal-vertical transformation in this step.

Returns an empty string if no WKT has been specified or if the horizontal-vertical transformation is invalid.

This method always returns the minimal text representation that uniquely identifies a given horizontal-vertical transformation.

int HorizontalVerticalTransformationStep::wkid() const

Returns the Well-Known Identifier (WKID) of the horizontal-vertical transformation in this step.

Returns -1 if no WKID has been specified.

bool HorizontalVerticalTransformationStep::operator!=(const Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &other) const

Inequality operator. Returns true if this object and other are not equal.

See also HorizontalVerticalTransformationStep::operator==.

bool HorizontalVerticalTransformationStep::operator==(const Esri::ArcGISRuntime::HorizontalVerticalTransformationStep &other) const

Equivalency operator. Returns true if this object and other are equal.

This is the only valid way to compare two horizontal-vertical transformation steps. Comparing individual attributes for two objects can return misleading results and should be avoided.


Feedback on this topic?