OdEllipsoidDefinition.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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 _ODSPATIALREFERENCE_ODELLIPSOIDDEFINITION_INCLUDED_
#define _ODSPATIALREFERENCE_ODELLIPSOIDDEFINITION_INCLUDED_
 
#include "OdDefinitionBase.h"
 
namespace OdSpatialReference
{
  class OdEllipsoidDefinition;

  typedef OdSmartPtr<OdEllipsoidDefinition> OdEllipsoidDefinitionPtr;

  typedef OdArray<OdEllipsoidDefinitionPtr> OdEllipsoidDefinitionArray;
 
  class OdEllipsoidDefinitionImpl;
  
  class TD_SPATIALREFERENCE_API OdEllipsoidDefinition : public OdDefinitionBase
  {
    ODSPREF_RX_DECLARE_MEMBERS(OdEllipsoidDefinition);
  public:
    static OdResult load(const OdString& sCode, OdEllipsoidDefinitionPtr& pEllipsoidDefinition);

    static OdResult loadAll(OdEllipsoidDefinitionArray& arrEllipsoidDefinition);

    TD_SPATIALREFERENCE_API_STATIC static const double kdMinEllipsoidRadius;

    TD_SPATIALREFERENCE_API_STATIC static const double kdMaxEllipsoidRadius;

    TD_SPATIALREFERENCE_API_STATIC static const double kdMinEllipsoidFlat;
    
    TD_SPATIALREFERENCE_API_STATIC static const double kdMaxEllipsoidFlat;

    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);

    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);

    static bool isLegalCode(const OdString& sCode);

    static bool isLegalDescription(const OdString& sDescription);

    static bool isLegalSource(const OdString& sSource);

    static bool isLegalGroup(const OdString& sGroup);
  };
}
 
#endif //_ODSPATIALREFERENCE_ODELLIPSOIDDEFINITION_INCLUDED_