OdSpatialReference::Helper Namespace Reference

Functions
TD_SPATIALREFERENCE_API OdResult	getUnitCodeName (UnitCode eUnitCode, OdString &sName)
TD_SPATIALREFERENCE_API OdResult	getUnitCode (const OdString &sName, UnitCode &eUnitCode)
TD_SPATIALREFERENCE_API OdResult	getUnitCodeInformation (UnitCode eUnitCode, UnitType &eUnitType, double &dScale)
TD_SPATIALREFERENCE_API OdResult	getProjectionCodeName (ProjectionCode eProjectionCode, OdString &sName)
TD_SPATIALREFERENCE_API OdResult	getProjectionCode (const OdString &sName, ProjectionCode &eProjectionCode)
TD_SPATIALREFERENCE_API OdResult	getProjectionFlags (ProjectionCode eProjectionCode, OdUInt32 &uFlags)
TD_SPATIALREFERENCE_API CoordinateReferenceSystemType	getCoordinateSystemType (ProjectionCode eProjectionCode)
TD_SPATIALREFERENCE_API ParameterType	getParameterCode (ProjectionCode eProjectionCode, OdUInt32 uIndex)
TD_SPATIALREFERENCE_API OdString	getParameterDescription (OdUInt32 ePrmCode, OdUInt32 uIndex=0)

Function Documentation

getCoordinateSystemType()

TD_SPATIALREFERENCE_API CoordinateReferenceSystemType OdSpatialReference::Helper::getCoordinateSystemType

(

ProjectionCode

eProjectionCode

)

Determines the coordinate reference system type by input projection code.

Parameters

eProjectionCode

[in] ProjectionCode enum value.

Returns

Returns Enum value CoordinateReferenceSystemType.

getParameterCode()

TD_SPATIALREFERENCE_API ParameterType OdSpatialReference::Helper::getParameterCode	(	ProjectionCode	eProjectionCode,
		OdUInt32	uIndex )

Gets parameter code of input projection at specified index.

Parameters

eProjectionCode	[in] ProjectionCode enum value.
uIndex	[in] Index of requested parameter (max projection parameters count is 24).

Returns

Returns Enum value ParameterType.

getParameterDescription()

TD_SPATIALREFERENCE_API OdString OdSpatialReference::Helper::getParameterDescription	(	OdUInt32	ePrmCode,
		OdUInt32	uIndex = 0 )

Gets description of parameter.

Parameters

ePrmCode	[in] ParameterType enum value expected.
uIndex	[in] Index of requested parameter (needed for Complex Series Coefficient's).

Returns

Returns Enum value ParameterType.

getProjectionCode()

TD_SPATIALREFERENCE_API OdResult OdSpatialReference::Helper::getProjectionCode	(	const OdString &	sName,
		ProjectionCode &	eProjectionCode )

Converts the projection code name to projection code enum value.

Parameters

sName	[in] Projection code name.
eProjectionCode	[out] ProjectionCode enum value.

Returns

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

getProjectionCodeName()

TD_SPATIALREFERENCE_API OdResult OdSpatialReference::Helper::getProjectionCodeName	(	ProjectionCode	eProjectionCode,
		OdString &	sName )

Converts the projection code enum value to projection code name.

Parameters

eUnitCode	[in] ProjectionCode enum value.
sName	[out] Projection code name.

Returns

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

getProjectionFlags()

TD_SPATIALREFERENCE_API OdResult OdSpatialReference::Helper::getProjectionFlags	(	ProjectionCode	eProjectionCode,
		OdUInt32 &	uFlags )

Returns the projection flag for input projection.

Parameters

eProjectionCode	[in] ProjectionCode enum value.
uFlags	[out] projection flags.

Returns

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

getUnitCode()

TD_SPATIALREFERENCE_API OdResult OdSpatialReference::Helper::getUnitCode	(	const OdString &	sName,
		UnitCode &	eUnitCode )

Converts the unit code name to unit code enum value.

Parameters

sName	[in] Unit code name.
eUnitCode	[out] UnitCode enum value.

Returns

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

getUnitCodeInformation()

TD_SPATIALREFERENCE_API OdResult OdSpatialReference::Helper::getUnitCodeInformation	(	UnitCode	eUnitCode,
		UnitType &	eUnitType,
		double &	dScale )

Gets the unit code information: unit type and scale.

Parameters

eUnitCode	[in] UnitCode enum value.
eUnitType	[out] UnitType enum value.
dScale	[out] Scale.

Returns

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

getUnitCodeName()

TD_SPATIALREFERENCE_API OdResult OdSpatialReference::Helper::getUnitCodeName	(	UnitCode	eUnitCode,
		OdString &	sName )

Converts the unit code enum value to unit code name.

Parameters

eUnitCode	[in] UnitCode enum value.
sName	[out] Unit code name.

Returns

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