#include <OdEllipsoidDefinition.h>

Inheritance diagram for OdSpatialReference::OdEllipsoidDefinition:

Public Member Functions
OdResult	getEquatorialRadius (double &dRadius) const

OdResult	setEquatorialRadius (double dRadius)

OdResult	getPolarRadius (double &dRadius) const

OdResult	setPolarRadius (double dRadius)

OdResult	getFlatteningRatio (double &dFlatteningRatio) const

OdResult	getEccentricity (double &dEccentricity) const

OdResult	isProtected (bool &bProtected) const

OdResult	setProtected (bool bProtected)

OdResult	getGreatCircle (double dLongitude1, double dLatitude1, double dLongitude2, double dLatitude2, double &dDistance, double &dAzimuth) const

OdResult	getGroup (OdString &sGroup) const

OdResult	setGroup (const OdString &sGroup)

OdResult	getEpsgCode (OdInt16 &nEpsgCode) const

OdResult	setEpsgCode (OdInt16 nEpsgCode)

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, OdEllipsoidDefinitionPtr &pEllipsoidDefinition)

static OdResult	loadAll (OdEllipsoidDefinitionArray &arrEllipsoidDefinition)

static bool	isLegalRadius (double dRadius)

static bool	isLegalFlatteningRatio (double dEquatorial, double dPolar)

static bool	isLegalFlatteningRatio (double dFlat)

static double	flatteningRatio (double dEquatorial, double dPolar)

static double	flatteningRatio (double dEccentricity)

static double	eccentricity (double dFlat)

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 Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Static Public Attributes
static TD_SPATIALREFERENCE_API_STATIC const double	kdMinEllipsoidRadius

static TD_SPATIALREFERENCE_API_STATIC const double	kdMaxEllipsoidRadius

static TD_SPATIALREFERENCE_API_STATIC const double	kdMinEllipsoidFlat

static TD_SPATIALREFERENCE_API_STATIC const double	kdMaxEllipsoidFlat

Detailed Description

This class represents an ellipsoid definition.

Definition at line 49 of file OdEllipsoidDefinition.h.

Member Function Documentation

◆ eccentricity()

static double OdSpatialReference::OdEllipsoidDefinition::eccentricity ( double dFlat )

static

Calculates eccentricity.

Parameters

dFlat [in] Flattening ratio.

Returns: Eccentricity.

◆ flatteningRatio() [1/2]

static double OdSpatialReference::OdEllipsoidDefinition::flatteningRatio ( double dEccentricity )

static

Calculates flattening ratio.

Parameters

dEccentricity [in] Eccentricity.

Returns: Flattening ratio.

◆ flatteningRatio() [2/2]

static double OdSpatialReference::OdEllipsoidDefinition::flatteningRatio	(	double	dEquatorial,
		double	dPolar )

static

Calculates flattening ratio.

Parameters

dEquatorial	[in] Equatorial radius.
dPolar	[in] Polar radius.

Returns: Flattening ratio.

◆ getEccentricity()

OdResult OdSpatialReference::OdEllipsoidDefinition::getEccentricity ( double & dEccentricity ) const

Returns the eccentricity of this ellipsoid definition.

Parameters

dEccentricity [out] Eccentricity.

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

◆ getEpsgCode()

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

Returns the EPSG number of this ellipsoid definition.

Parameters

nEpsgCode [out] EPSG number.

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

◆ getEquatorialRadius()

OdResult OdSpatialReference::OdEllipsoidDefinition::getEquatorialRadius ( double & dRadius ) const

Returns the equatorial radius of this ellipsoid definition.

Parameters

dRadius [out] Equatorial radius.

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

◆ getFlatteningRatio()

OdResult OdSpatialReference::OdEllipsoidDefinition::getFlatteningRatio ( double & dFlatteningRatio ) const

Returns the flattening ratio of this ellipsoid definition.

Parameters

dFlatteningRatio [out] Flattening ratio.

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

◆ getGreatCircle()

OdResult OdSpatialReference::OdEllipsoidDefinition::getGreatCircle	(	double	dLongitude1,
		double	dLatitude1,
		double	dLongitude2,
		double	dLatitude2,
		double &	dDistance,
		double &	dAzimuth ) const

Returns great circle distance and azimuth between two coordinates.

Parameters

dLongitude1	[in] Longitude coordinate of first point.
dLatitude1	[in] Latitude coordinate of first point.
dLongitude2	[in] Longitude coordinate of second point.
dLatitude2	[in] Latitude coordinate of second point.
dDistance	[out] Distance in meters.
dAzimuth	[out] Azimuth in degrees.

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

◆ getGroup()

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

Returns the group string of this ellipsoid definition.

Parameters

sGroup [out] Group string.

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

◆ getPolarRadius()

OdResult OdSpatialReference::OdEllipsoidDefinition::getPolarRadius ( double & dRadius ) const

Returns the polar radius of this ellipsoid definition.

Parameters

dRadius [out] Polar radius.

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

◆ isLegalCode()

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

static

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

Parameters

sCode [in] Ellipsoid definition code string.

Returns: true - if specified code string is valid.

◆ isLegalDescription()

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

static

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

Parameters

sDescription [in] Ellipsoid definition description string.

Returns: true - if specified description string is valid.

◆ isLegalFlatteningRatio() [1/2]

static bool OdSpatialReference::OdEllipsoidDefinition::isLegalFlatteningRatio	(	double	dEquatorial,
		double	dPolar )

static

Checks flattening ratio for validity.

Parameters

dEquatorial	[in] Equatorial radius.
dPolar	[in] Polar radius.

Returns: true is valid.

◆ isLegalFlatteningRatio() [2/2]

static bool OdSpatialReference::OdEllipsoidDefinition::isLegalFlatteningRatio ( double dFlat )

static

Checks flattening ratio for validity.

Parameters

dFlat [in] Flattening ratio.

Returns: true is valid.

◆ isLegalGroup()

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

static

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

Parameters

sGroup [in] Ellipsoid definition group string.

Returns: true - if specified group string is valid.

◆ isLegalRadius()

static bool OdSpatialReference::OdEllipsoidDefinition::isLegalRadius ( double dRadius )

static

Checks ellipsoid radius for validity.

Parameters

dRadius [in] Equatorial radius.

Returns: true if radius is valid.

◆ isLegalSource()

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

static

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

Parameters

sSource [in] Ellipsoid definition source string.

Returns: true - if specified source string is valid.

◆ isProtected()

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

Returns the flag to check if this ellipsoid definition 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::OdEllipsoidDefinition::load	(	const OdString &	sCode,
		OdEllipsoidDefinitionPtr &	pEllipsoidDefinition )

static

Loads and returns coordinate reference system definition.

Parameters

sCode	[in] Ellipsoid code.
pEllipsoidDefinition	[out] Pointer to an OdEllipsoidDefinition object.

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

◆ loadAll()

static OdResult OdSpatialReference::OdEllipsoidDefinition::loadAll ( OdEllipsoidDefinitionArray & arrEllipsoidDefinition )

static

Loads and returns all ellipsoid definitions.

Parameters

arrEllipsoidDefinition [out] Array of pointers to returned ellipsoid definitions.

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

◆ setEpsgCode()

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

Sets the EPSG number to this ellipsoid definition.

Parameters

nEpsgCode [in] EPSG number.

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

◆ setEquatorialRadius()

OdResult OdSpatialReference::OdEllipsoidDefinition::setEquatorialRadius ( double dRadius )

Sets the equatorial radius of this ellipsoid definition.

Parameters

dRadius [in] Equatorial radius.

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

◆ setGroup()

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

Sets the group string to this ellipsoid definition.

Parameters

sGroup [in] Group string.

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

◆ setPolarRadius()

OdResult OdSpatialReference::OdEllipsoidDefinition::setPolarRadius ( double dRadius )

Sets the polar radius of this ellipsoid definition.

Parameters

dRadius [in] Polar radius.

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

◆ setProtected()

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

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

Parameters

bProtected [in] Flag is protected.

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

Member Data Documentation

◆ kdMaxEllipsoidFlat

TD_SPATIALREFERENCE_API_STATIC const double OdSpatialReference::OdEllipsoidDefinition::kdMaxEllipsoidFlat

static

Maximum ellipsoid flattening allowed.

Definition at line 90 of file OdEllipsoidDefinition.h.

◆ kdMaxEllipsoidRadius

TD_SPATIALREFERENCE_API_STATIC const double OdSpatialReference::OdEllipsoidDefinition::kdMaxEllipsoidRadius

static

Maximum ellipsoid radius allowed.

Definition at line 80 of file OdEllipsoidDefinition.h.

◆ kdMinEllipsoidFlat

TD_SPATIALREFERENCE_API_STATIC const double OdSpatialReference::OdEllipsoidDefinition::kdMinEllipsoidFlat

static

Minimum ellipsoid flattening allowed.

Definition at line 85 of file OdEllipsoidDefinition.h.

◆ kdMinEllipsoidRadius

TD_SPATIALREFERENCE_API_STATIC const double OdSpatialReference::OdEllipsoidDefinition::kdMinEllipsoidRadius

static

Minimum ellipsoid radius allowed.

Definition at line 75 of file OdEllipsoidDefinition.h.

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

OdEllipsoidDefinition.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ eccentricity()

◆ flatteningRatio() [1/2]

◆ flatteningRatio() [2/2]

◆ getEccentricity()

◆ getEpsgCode()

◆ getEquatorialRadius()

◆ getFlatteningRatio()

◆ getGreatCircle()

◆ getGroup()

◆ getPolarRadius()

◆ isLegalCode()

◆ isLegalDescription()

◆ isLegalFlatteningRatio() [1/2]

◆ isLegalFlatteningRatio() [2/2]

◆ isLegalGroup()

◆ isLegalRadius()

◆ isLegalSource()

◆ isProtected()

◆ load()

◆ loadAll()

◆ setEpsgCode()

◆ setEquatorialRadius()

◆ setGroup()

◆ setPolarRadius()

◆ setProtected()

Member Data Documentation

◆ kdMaxEllipsoidFlat

◆ kdMaxEllipsoidRadius

◆ kdMinEllipsoidFlat

◆ kdMinEllipsoidRadius