OdDatumDefinition.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_ODDATUMDEFINITION_INCLUDED_
#define _ODSPATIALREFERENCE_ODDATUMDEFINITION_INCLUDED_
 
#include "OdEllipsoidDefinition.h"
 
namespace OdSpatialReference
{
  class OdDatumDefinition;

  typedef OdSmartPtr<OdDatumDefinition> OdDatumDefinitionPtr;

  typedef OdArray<OdDatumDefinitionPtr> OdDatumDefinitionArray;
 
  class OdDatumDefinitionImpl;
  
  class TD_SPATIALREFERENCE_API OdDatumDefinition : public OdDefinitionBase
  {
    ODSPREF_RX_DECLARE_MEMBERS(OdDatumDefinition);
  public:
    static OdResult load(const OdString & sCode, OdDatumDefinitionPtr & pDatumDefinition);
    
    static OdResult loadAll(OdDatumDefinitionArray& arrDatumDefinition);

    OdResult getEllipsoid(OdString& sEllipsoid) const;

    OdResult setEllipsoid(const OdString& sEllipsoid);

    OdResult getEllipsoidDefinition(OdEllipsoidDefinitionPtr & pEllipsoid) const;

    OdResult setEllipsoidDefinition(const OdEllipsoidDefinition * pEllipsoid);

    OdResult isProtected(bool& bProtected) const;

    OdResult setProtected(bool bProtected);

    OdResult getGroup(OdString& sGroup) const;

    OdResult setGroup(const OdString& sGroup);

    OdResult getLocation(OdString& sLocation) const;

    OdResult setLocation(const OdString& sLocation);

    OdResult getCountryOrState(OdString& sCountryOrState) const;

    OdResult setCountryOrState(const OdString& sCountryOrState);

    OdResult getEpsgCode(OdInt16& nEpsgCode) const;

    OdResult setEpsgCode(OdInt16 nEpsgCode);

    OdResult getDatumCalculationTechnique(DatumCalculationTechnique& eDatumCalcTech) const;

    OdResult setDatumCalculationTechnique(const DatumCalculationTechnique& eDatumCalcTech);

    OdResult getOffset( double& dXOffset, double& dYOffset, double& dZOffset ) const;

    OdResult setOffset(double dXOffset, double dYOffset, double dZOffset);

    OdResult getScale(double& dScale) const;

    OdResult setScale(double dScale);

    OdResult getRotationAngles(double& dXRot, double& dYRot, double& dZRot) const;

    OdResult setRotationAngles(double dXRot, double dYRot, double dZRot);

    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 bool isLegalLocation(const OdString& sLocation);

    static bool isLegalCountryOrState(const OdString& sCountryOrState);
  };
}
 
#endif //_ODSPATIALREFERENCE_ODDATUMDEFINITION_INCLUDED_