CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdDbGeoDataPE Class Referenceabstract

#include <DbGeoDataPE.h>

Inheritance diagram for OdDbGeoDataPE:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbGeoDataPE)
 
virtual ~OdDbGeoDataPE ()
 
virtual OdResult transformFromLonLatAlt (const OdDbGeoData *pGeoData, const double &dblLongitude, const double &dblLatitude, const double &dblAltitude, double &dblDwgX, double &dblDwgY, double &dblDwgZ)=0
 
virtual OdResult transformToLonLatAlt (const OdDbGeoData *pGeoData, const double &dblDwgX, const double &dblDwgY, const double &dblDwgZ, double &dblLongitude, double &dblLatitude, double &dblAltitude)=0
 
virtual bool validateCs (const OdString &coordinateSystem)=0
 
virtual OdResult parseCsName (const OdDbGeoData *pGeoData, const OdString &inputName, OdString &resultXml)=0
 
virtual OdResult geoCoordinateSystemWillChange (OdDbGeoData *pGeoData, const OdString &newName)=0
 
virtual OdResult geoCoordinateSystemChanged (OdDbGeoData *pGeoData, const OdString &oldName)=0
 
virtual OdString parseIdFromXml (const OdString &xml)=0
 
- 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
 

Additional Inherited Members

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

Detailed Description

An abstract class that represents a protocol extension for an OdDbGeoData object.

<group OdDb_Classes>

Definition at line 38 of file DbGeoDataPE.h.

Constructor & Destructor Documentation

◆ ~OdDbGeoDataPE()

virtual OdDbGeoDataPE::~OdDbGeoDataPE ( )
inlinevirtual

Virtual destructor.

Definition at line 46 of file DbGeoDataPE.h.

Member Function Documentation

◆ geoCoordinateSystemChanged()

virtual OdResult OdDbGeoDataPE::geoCoordinateSystemChanged ( OdDbGeoData pGeoData,
const OdString oldName 
)
pure virtual

This method is called when the coordinate system is changed.

Parameters
pGeoData[in/out] Pointer to an OdDbGeoData object.
oldName[in] Coordinate system name.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ geoCoordinateSystemWillChange()

virtual OdResult OdDbGeoDataPE::geoCoordinateSystemWillChange ( OdDbGeoData pGeoData,
const OdString newName 
)
pure virtual

This method is called when the coordinate system will be changed.

Parameters
pGeoData[in/out] Pointer to an OdDbGeoData object.
oldName[in] Coordinate system name.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ ODRX_DECLARE_MEMBERS()

OdDbGeoDataPE::ODRX_DECLARE_MEMBERS ( OdDbGeoDataPE  )

◆ parseCsName()

virtual OdResult OdDbGeoDataPE::parseCsName ( const OdDbGeoData pGeoData,
const OdString inputName,
OdString resultXml 
)
pure virtual

Returns xml representation of the coordinate system.

Parameters
pGeoData[in] Pointer to an OdDbGeoData object.
inputName[in] Coordinate system name.
resultXml[out] Xml representation of the coordinate system.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ parseIdFromXml()

virtual OdString OdDbGeoDataPE::parseIdFromXml ( const OdString xml)
pure virtual

Parses and returns the coordinate system ID.

Parameters
xml[in] String with xml representation of coordinate system.

◆ transformFromLonLatAlt()

virtual OdResult OdDbGeoDataPE::transformFromLonLatAlt ( const OdDbGeoData pGeoData,
const double &  dblLongitude,
const double &  dblLatitude,
const double &  dblAltitude,
double &  dblDwgX,
double &  dblDwgY,
double &  dblDwgZ 
)
pure virtual

Transforms the geographic point into an equivalent design point.

Parameters
pGeoData[in] Pointer to an OdDbGeoData object.
dblLongitude[in] Longitude ordinate of the point to be transformed.
dblLatitude[in] Latitude ordinate of the point to be transformed.
dblAltitude[in] Altitude ordinate of the point to be transformed.
dblDwgX[out] X ordinate of the transformed point.
dblDwgY[out] Y ordinate of the transformed point.
dblDwgZ[out] Z ordinate of the transformed point.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ transformToLonLatAlt()

virtual OdResult OdDbGeoDataPE::transformToLonLatAlt ( const OdDbGeoData pGeoData,
const double &  dblDwgX,
const double &  dblDwgY,
const double &  dblDwgZ,
double &  dblLongitude,
double &  dblLatitude,
double &  dblAltitude 
)
pure virtual

Transforms the design point into an equivalent geographic point.

Parameters
pGeoData[in] Pointer to an OdDbGeoData object.
dblDwgX[in] X ordinate of the design point.
dblDwgY[in] Y ordinate of the design point.
dblDwgZ[in] Z ordinate of the design point.
dblLongitude[out] Longitude ordinate of the transformed point.
dblLatitude[out] Latitude ordinate of the transformed point.
dblAltitude[out] Altitude (elevation) ordinate of the transformed point.
Returns
Returns eOK if successful, or an appropriate error code if not.

◆ validateCs()

virtual bool OdDbGeoDataPE::validateCs ( const OdString coordinateSystem)
pure virtual

This method is used for user validation.

Parameters
coordinateSystem[in] Coordinate system name.
Returns
Returns true if validation passed successfully, or false if not.

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