/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
#ifndef _OD_DB_GEODATA_PE_
#define _OD_DB_GEODATA_PE_

#include "RxObject.h"
#include "SmartPtr.h"
#include "DbExport.h"

#include "DbGeoData.h"

#include "TD_PackPush.h"
/** \details
An abstract class that represents a protocol extension for an OdDbGeoData object.

<group OdDb_Classes> 
*/
class TOOLKIT_EXPORT OdDbGeoDataPE : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbGeoDataPE);
  
  /** \details
    Virtual destructor.
  */
  virtual ~OdDbGeoDataPE() {};
  /** \details
    Transforms the geographic point into an equivalent design point.
    
    \param pGeoData [in] Pointer to an OdDbGeoData object.
    \param dLongitude [in] Longitude ordinate of the point to be transformed. 
    \param dLatitude [in] Latitude ordinate of the point to be transformed. 
    \param dAltitude [in] Altitude ordinate of the point to be transformed. 
    \param dDwgX [out] X ordinate of the transformed point.
    \param dDwgY [out] Y ordinate of the transformed point.
    \param dDwgZ [out] Z ordinate of the transformed point.
    
    \returns Returns eOK if successful, or an appropriate error code if not.
  */
  virtual OdResult transformFromLonLatAlt(const OdDbGeoData* pGeoData, const double& dLongitude, const double& dLatitude, const double& dAltitude,
                                                             double& dDwgX, double& dDwgY, double& dDwgZ) = 0;
  /** \details
    Transforms the design point into an equivalent geographic point.
    
    \param pGeoData [in] Pointer to an OdDbGeoData object.
    \param dDwgX [in] X ordinate of the design point.
    \param dDwgY [in] Y ordinate of the design point.
    \param dDwgZ [in] Z ordinate of the design point.
    \param dLongitude [out] Longitude ordinate of the transformed point. 
    \param dLatitude [out] Latitude ordinate of the transformed point. 
    \param dAltitude [out] Altitude (elevation) ordinate of the transformed point. 
    
    \returns Returns eOK if successful, or an appropriate error code if not.
  */
  virtual OdResult transformToLonLatAlt(const OdDbGeoData* pGeoData, const double& dDwgX, const double& dDwgY, const double& dDwgZ,
                                                             double& dLongitude, double& dLatitude, double& dAltitude) = 0;
  /** \details
    This method is used for user validation.
    
    \param sCoordinateSystem [in] Coordinate system name.
     
    \returns Returns true if validation passed successfully, or false if not.
  */
  virtual bool validateCs(const OdString & sCoordinateSystem) = 0;
  
  /** \details
    This method is called when the coordinate system will be changed.
    
    \param pGeoData [in/out] Pointer to an OdDbGeoData object.
    \param sNewCsId [in] Future coordinate system name.
     
    \returns Returns eOK if successful, or an appropriate error code if not.
  */
  virtual OdResult geoCoordinateSystemWillChange(OdDbGeoData* pGeoData, const OdString& sNewCsId) = 0;
  
  /** \details
    This method is called when the coordinate system is changed.
    
    \param pGeoData [in/out] Pointer to an OdDbGeoData object.
    \param sOldCsId [in] Previous coordinate system name.
     
    \returns Returns eOK if successful, or an appropriate error code if not.
  */
  virtual OdResult geoCoordinateSystemChanged(OdDbGeoData* pGeoData, const OdString& sOldCsId) = 0;
  
  /** \details
    This method is called when the coordinate system will be changed.

    \param pGeoData [in/out] Pointer to an OdDbGeoData object.
    \param sNewCsId [in] Future coordinate system name.
    \param sNewVcsId [in] Future vertical coordinate system name.

    \returns Returns eOK if successful, or an appropriate error code if not.
  */
  virtual OdResult geoCoordinateSystemWillChange(OdDbGeoData* pGeoData, const OdString& sNewCsId, const OdString& /*sNewVcsId*/)
  {
    return geoCoordinateSystemWillChange(pGeoData, sNewCsId);
  }

  /** \details
    This method is called when the coordinate system is changed.
  
    \param pGeoData [in/out] Pointer to an OdDbGeoData object.
    \param sOldCsId [in] Previous coordinate system name.
    \param sOldVcsId [in] Previous vertical coordinate system name.
  
    \returns Returns eOK if successful, or an appropriate error code if not.
  */
  virtual OdResult geoCoordinateSystemChanged(OdDbGeoData* pGeoData, const OdString& sOldCsId, const OdString& /*sOldVcsId*/)
  {
    return geoCoordinateSystemChanged(pGeoData, sOldCsId);
  }
};

typedef OdSmartPtr<OdDbGeoDataPE> OdDbGeoDataPEPtr;

#include "TD_PackPop.h"

#endif //_OD_DB_GEODATA_PE_