CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdSpatialReference::OdDatumShift Class Reference

#include <OdDatumShift.h>

Inheritance diagram for OdSpatialReference::OdDatumShift:
OdRxObject

Public Member Functions

OdResult convert3D (double &dLon, double &dLat, double &dHeight) const
 
OdResult convert (double &dLon, double &dLat) const
 
OdResult getPath (OdGeodeticPathDefinitionPtr &pGeodeticPathDefinition) const
 
OdResult getAt (OdUInt32 uIndex, bool &bIsInversed, OdGeodeticTransformationDefinitionPtr &pGeodeticTransformationDefinition) const
 
OdResult getCount (OdUInt32 &uCount) const
 
bool isNullTransformation () const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static OdResult load (const OdDatumDefinition *pDatumSource, const OdDatumDefinition *pDatumTarget, OdDatumShiftPtr &pDatumShift)
 
static OdResult load (const OdString &sDatumSource, const OdString &sDatumTarget, OdDatumShiftPtr &pDatumShift)
 
static OdResult getDatumShift (const OdGeodeticTransformationDefinition *pGeodeticTransformationDefinition, bool bInverse, OdDatumShiftPtr &pDatumShift)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Detailed Description

This class represents a datum shift.

<group OdSpatialReference_Classes>

Definition at line 46 of file OdDatumShift.h.

Member Function Documentation

◆ convert()

OdResult OdSpatialReference::OdDatumShift::convert ( double & dLon,
double & dLat ) const

Converts coordinate (longitude, latitude) using current datum shift.

Parameters
dLon[in/out] Longitude.
dLat[in/out] Latitude.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ convert3D()

OdResult OdSpatialReference::OdDatumShift::convert3D ( double & dLon,
double & dLat,
double & dHeight ) const

Converts coordinate (longitude, latitude, height) using current datum shift.

Parameters
dLon[in/out] Longitude.
dLat[in/out] Latitude.
dHeight[in/out] Height.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ getAt()

OdResult OdSpatialReference::OdDatumShift::getAt ( OdUInt32 uIndex,
bool & bIsInversed,
OdGeodeticTransformationDefinitionPtr & pGeodeticTransformationDefinition ) const

Returns the geodetic transformation definition of this datum shift.

Parameters
uIndex[in] Index of geodetic transformation definition object.
bIsInversed[out] If true - geodetic transformation definition object is used as inversed.
pGeodeticTransformationDefinition[out] Pointer to an OdGeodeticTransformationDefinition object.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ getCount()

OdResult OdSpatialReference::OdDatumShift::getCount ( OdUInt32 & uCount) const

Returns the geodetic transformation definitions count of this datum shift.

Parameters
uCount[out] Count of geodetic transformation definitions.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ getDatumShift()

static OdResult OdSpatialReference::OdDatumShift::getDatumShift ( const OdGeodeticTransformationDefinition * pGeodeticTransformationDefinition,
bool bInverse,
OdDatumShiftPtr & pDatumShift )
static

Gets the datum shift object from geodetic transformation definition.

Parameters
pGeodeticTransformationDefinition[in] Pointer to an OdGeodeticTransformationDefinition object.
bInverse[in] Direction of resulted datum shift: true - inversed, false - forward.
pDatumShift[out] Pointer to an OdDatumShift object.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ getPath()

OdResult OdSpatialReference::OdDatumShift::getPath ( OdGeodeticPathDefinitionPtr & pGeodeticPathDefinition) const

Returns the geodetic path definition of this datum shift.

Parameters
pGeodeticPathDefinition[out] Pointer to an OdGeodeticPathDefinition object.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ isNullTransformation()

bool OdSpatialReference::OdDatumShift::isNullTransformation ( ) const

Determines whether this datum shift has no transformations to be applied.

Returns
true if this datum shift object has no transformations to be applied.

◆ load() [1/2]

static OdResult OdSpatialReference::OdDatumShift::load ( const OdDatumDefinition * pDatumSource,
const OdDatumDefinition * pDatumTarget,
OdDatumShiftPtr & pDatumShift )
static

Creates datum shift by source and target datum definitions.

Parameters
pDatumSource[in] Pointer to source datum definition.
pDatumTarget[in] Pointer to target datum definition.
pDatumShift[out] Pointer to datum shift, result of loading.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ load() [2/2]

static OdResult OdSpatialReference::OdDatumShift::load ( const OdString & sDatumSource,
const OdString & sDatumTarget,
OdDatumShiftPtr & pDatumShift )
static

Creates datum shift by source and target datum names.

Parameters
sDatumSource[in] Name to source datum.
sDatumTarget[in] Name to target datum.
pDatumShift[out] Pointer to datum shift, result of loading.
Returns
Returns eOK if successful, or an appropriate error code if not.

The documentation for this class was generated from the following file: