#include <OdDatumDefinition.h>

Inheritance diagram for OdSpatialReference::OdDatumDefinition:

Public Member Functions
OdResult	getEllipsoid (OdString &sEllipsoid) const

OdResult	setEllipsoid (const OdString &sEllipsoid)

OdResult	getEllipsoidDefinition (OdEllipsoidDefinitionPtr &pEllipsoid) const

OdResult	setEllipsoidDefinition (const OdEllipsoidDefinition *pEllipsoid)

OdResult	isProtected (bool &bProtected) const

OdResult	setProtected (bool bProtected)

OdResult	getGroup (OdString &sGroup) const

OdResult	setGroup (const OdString &sGroup)

OdResult	getLocation (OdString &sLocation) const

OdResult	setLocation (const OdString &sLocation)

OdResult	getCountryOrState (OdString &sCountryOrState) const

OdResult	setCountryOrState (const OdString &sCountryOrState)

OdResult	getEpsgCode (OdInt16 &nEpsgCode) const

OdResult	setEpsgCode (OdInt16 nEpsgCode)

OdResult	getDatumCalculationTechnique (DatumCalculationTechnique &eDatumCalcTech) const

OdResult	setDatumCalculationTechnique (const DatumCalculationTechnique &eDatumCalcTech)

OdResult	getOffset (double &dXOffset, double &dYOffset, double &dZOffset) const

OdResult	setOffset (double dXOffset, double dYOffset, double dZOffset)

OdResult	getScale (double &dScale) const

OdResult	setScale (double dScale)

OdResult	getRotationAngles (double &dXRot, double &dYRot, double &dZRot) const

OdResult	setRotationAngles (double dXRot, double dYRot, double dZRot)

Public Member Functions inherited from OdSpatialReference::OdDefinitionBase
void	initialize (bool bReset=false)

OdResult	update ()

OdResult	remove ()

DefinitionType	getDefinitionType () const

OdResult	getCode (OdString &sCode) const

OdResult	setCode (const OdString &sCode)

OdResult	getDescription (OdString &sDescription) const

OdResult	setDescription (const OdString &sDescription)

OdResult	getSource (OdString &sSource) const

OdResult	setSource (const OdString &sSource)

virtual void	copyFrom (const OdRxObject *pSource) ODRX_OVERRIDE

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdResult	load (const OdString &sCode, OdDatumDefinitionPtr &pDatumDefinition)

static OdResult	loadAll (OdDatumDefinitionArray &arrDatumDefinition)

static bool	isLegalCode (const OdString &sCode)

static bool	isLegalDescription (const OdString &sDescription)

static bool	isLegalSource (const OdString &sSource)

static bool	isLegalGroup (const OdString &sGroup)

static bool	isLegalLocation (const OdString &sLocation)

static bool	isLegalCountryOrState (const OdString &sCountryOrState)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

This class represents a datum definition.

Definition at line 49 of file OdDatumDefinition.h.

Member Function Documentation

◆ getCountryOrState()

OdResult OdSpatialReference::OdDatumDefinition::getCountryOrState ( OdString & sCountryOrState ) const

Returns the country or state string of this datum definition.

Parameters

sCountryOrState [out] Country or state string.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getDatumCalculationTechnique()

OdResult OdSpatialReference::OdDatumDefinition::getDatumCalculationTechnique ( DatumCalculationTechnique & eDatumCalcTech ) const

Returns the datum calculation technique to convert from this datum to WGS84.

Parameters

eDatumCalcTech [out] Datum calculation technique.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getEllipsoid()

OdResult OdSpatialReference::OdDatumDefinition::getEllipsoid ( OdString & sEllipsoid ) const

Returns the ellipsoid code of this datum definition.

Parameters

sEllipsoid [out] Ellipsoid code.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getEllipsoidDefinition()

OdResult OdSpatialReference::OdDatumDefinition::getEllipsoidDefinition ( OdEllipsoidDefinitionPtr & pEllipsoid ) const

Returns the ellipsoid definition of this datum definition.

Parameters

pEllipsoid [out] Pointer to an OdEllipsoidDefinition object.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getEpsgCode()

OdResult OdSpatialReference::OdDatumDefinition::getEpsgCode ( OdInt16 & nEpsgCode ) const

Returns the EPSG number of this datum definition.

Parameters

nEpsgCode [out] EPSG number.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getGroup()

OdResult OdSpatialReference::OdDatumDefinition::getGroup ( OdString & sGroup ) const

Returns the group string of this datum definition.

Parameters

sGroup [out] Group string.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getLocation()

OdResult OdSpatialReference::OdDatumDefinition::getLocation ( OdString & sLocation ) const

Returns the location string of this datum definition.

Parameters

sLocation [out] Location code.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getOffset()

OdResult OdSpatialReference::OdDatumDefinition::getOffset	(	double &	dXOffset,
		double &	dYOffset,
		double &	dZOffset ) const

Returns components of the vector from the WGS-84 geocenter to the geocenter of this datum.

Parameters

dXOffset	[out] X-component of the vector.
dYOffset	[out] Y-component of the vector.
dZOffset	[out] Z-component of the vector.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getRotationAngles()

OdResult OdSpatialReference::OdDatumDefinition::getRotationAngles	(	double &	dXRot,
		double &	dYRot,
		double &	dZRot ) const

Returns angles from WGS-84 X, Y and Z axis to local geodetic system X, Y and Z axis in arc seconds.

Parameters

dXRot	[out] Angle from WGS-84 X axis to local geodetic system X axis in arc seconds, east is positive.
dYRot	[out] Angle from WGS-84 Y axis to local geodetic system Y axis in arc seconds, north is positive.
dZRot	[out] Angle from WGS-84 Z axis to local geodetic system Z axis in arc seconds, use right hand rule.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ getScale()

OdResult OdSpatialReference::OdDatumDefinition::getScale ( double & dScale ) const

Returns scale factor in parts per million of this datum.

Parameters

dScale [out] Scale factor.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ isLegalCode()

static bool OdSpatialReference::OdDatumDefinition::isLegalCode ( const OdString & sCode )

static

Checks whether the specified code string is legal for datum definition.

Parameters

sCode [in] Datum definition code string.

Returns: true - if specified code string is valid.

◆ isLegalCountryOrState()

static bool OdSpatialReference::OdDatumDefinition::isLegalCountryOrState ( const OdString & sCountryOrState )

static

Checks whether the specified country or state string is legal for datum definition.

Parameters

sCountryOrState [in] Datum definition country or state string.

Returns: true - if specified country or state string is valid.

◆ isLegalDescription()

static bool OdSpatialReference::OdDatumDefinition::isLegalDescription ( const OdString & sDescription )

static

Checks whether the specified description string is legal for datum definition.

Parameters

sDescription [in] Datum definition description string.

Returns: true - if specified description string is valid.

◆ isLegalGroup()

static bool OdSpatialReference::OdDatumDefinition::isLegalGroup ( const OdString & sGroup )

static

Checks whether the specified group string is legal for datum definition.

Parameters

sGroup [in] Datum definition group string.

Returns: true - if specified group string is valid.

◆ isLegalLocation()

static bool OdSpatialReference::OdDatumDefinition::isLegalLocation ( const OdString & sLocation )

static

Checks whether the specified location string is legal for datum definition.

Parameters

sLocation [in] Datum definition location string.

Returns: true - if specified location string is valid.

◆ isLegalSource()

static bool OdSpatialReference::OdDatumDefinition::isLegalSource ( const OdString & sSource )

static

Checks whether the specified source string is legal for datum definition.

Parameters

sSource [in] Datum definition source string.

Returns: true - if specified source string is valid.

◆ isProtected()

OdResult OdSpatialReference::OdDatumDefinition::isProtected ( bool & bProtected ) const

Returns the flag to check if this datum is protected from being changed by users.

Parameters

bProtected [out] Flag is protected.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ load()

static OdResult OdSpatialReference::OdDatumDefinition::load	(	const OdString &	sCode,
		OdDatumDefinitionPtr &	pDatumDefinition )

static

Loads and returns datum definition.

Parameters

sCode	[in] Datum definition code.
pDatumDefinition	[out] Pointer to an OdDatumDefinition object.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ loadAll()

static OdResult OdSpatialReference::OdDatumDefinition::loadAll ( OdDatumDefinitionArray & arrDatumDefinition )

static

Loads and returns all datum definitions.

Parameters

arrDatumDefinition [out] Array of pointers to returned datum definitions.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setCountryOrState()

OdResult OdSpatialReference::OdDatumDefinition::setCountryOrState ( const OdString & sCountryOrState )

Sets the country or state string to this datum definition.

Parameters

sCountryOrState [in] Country or state string.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setDatumCalculationTechnique()

OdResult OdSpatialReference::OdDatumDefinition::setDatumCalculationTechnique ( const DatumCalculationTechnique & eDatumCalcTech )

Sets the datum calculation technique to convert from this datum to WGS84.

Parameters

eDatumCalcTech [in] Datum calculation technique.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setEllipsoid()

OdResult OdSpatialReference::OdDatumDefinition::setEllipsoid ( const OdString & sEllipsoid )

Sets the ellipsoid to this datum definition.

Parameters

sEllipsoid [in] Ellipsoid code.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setEllipsoidDefinition()

OdResult OdSpatialReference::OdDatumDefinition::setEllipsoidDefinition ( const OdEllipsoidDefinition * pEllipsoid )

Sets the ellipsoid to this datum definition.

Parameters

pEllipsoid [in] Pointer to an OdEllipsoidDefinition object.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setEpsgCode()

OdResult OdSpatialReference::OdDatumDefinition::setEpsgCode ( OdInt16 nEpsgCode )

Sets the EPSG number to this datum definition.

Parameters

nEpsgCode [in] EPSG number.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setGroup()

OdResult OdSpatialReference::OdDatumDefinition::setGroup ( const OdString & sGroup )

Sets the group string to this datum definition.

Parameters

sGroup [in] Group string.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setLocation()

OdResult OdSpatialReference::OdDatumDefinition::setLocation ( const OdString & sLocation )

Sets the location string to this datum definition.

Parameters

sLocation [in] Location string.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setOffset()

OdResult OdSpatialReference::OdDatumDefinition::setOffset	(	double	dXOffset,
		double	dYOffset,
		double	dZOffset )

Sets components of the vector from the WGS-84 geocenter to the geocenter of this datum.

Parameters

dXOffset	[in] X-component of the vector.
dYOffset	[in] Y-component of the vector.
dZOffset	[in] Z-component of the vector.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setProtected()

OdResult OdSpatialReference::OdDatumDefinition::setProtected ( bool bProtected )

Sets the flag that indicates whether this datum definition can be changed by users.

Parameters

bProtected [in] Flag is protected.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setRotationAngles()

OdResult OdSpatialReference::OdDatumDefinition::setRotationAngles	(	double	dXRot,
		double	dYRot,
		double	dZRot )

Sets angles from WGS-84 X, Y and Z axis to local geodetic system X, Y and Z axis in arc seconds.

Parameters

dXRot	[in] Angle from WGS-84 X axis to local geodetic system X axis in arc seconds, east is positive.
dYRot	[in] Angle from WGS-84 Y axis to local geodetic system Y axis in arc seconds, north is positive.
dZRot	[in] Angle from WGS-84 Z axis to local geodetic system Z axis in arc seconds, use right hand rule.

Returns: Returns eOK if successful, or an appropriate error code if not.

◆ setScale()

OdResult OdSpatialReference::OdDatumDefinition::setScale ( double dScale )

Sets scale factor in parts per million of this datum.

Parameters

dScale [in] Scale factor.

Returns: Returns eOK if successful, or an appropriate error code if not.

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

OdDatumDefinition.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getCountryOrState()

◆ getDatumCalculationTechnique()

◆ getEllipsoid()

◆ getEllipsoidDefinition()

◆ getEpsgCode()

◆ getGroup()

◆ getLocation()

◆ getOffset()

◆ getRotationAngles()

◆ getScale()

◆ isLegalCode()

◆ isLegalCountryOrState()

◆ isLegalDescription()

◆ isLegalGroup()

◆ isLegalLocation()

◆ isLegalSource()

◆ isProtected()

◆ load()

◆ loadAll()

◆ setCountryOrState()

◆ setDatumCalculationTechnique()

◆ setEllipsoid()

◆ setEllipsoidDefinition()

◆ setEpsgCode()

◆ setGroup()

◆ setLocation()

◆ setOffset()

◆ setProtected()

◆ setRotationAngles()

◆ setScale()