OdGeodeticTransformationDefinition.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_ODGEODETICTRANSFORMATIONDEFINITION_INCLUDED_
#define _ODSPATIALREFERENCE_ODGEODETICTRANSFORMATIONDEFINITION_INCLUDED_
 
#include "OdDefinitionBase.h"
#include "OdGeodeticTransformationParameters.h"
 
namespace OdSpatialReference
{
  class OdGeodeticTransformationDefinition;

  typedef OdSmartPtr<OdGeodeticTransformationDefinition> OdGeodeticTransformationDefinitionPtr;

  typedef OdArray<OdGeodeticTransformationDefinitionPtr> OdGeodeticTransformationDefinitionArray;
 
  class OdGeodeticTransformationDefinitionImpl;
  
  class TD_SPATIALREFERENCE_API OdGeodeticTransformationDefinition : public OdDefinitionBase
  {
    ODSPREF_RX_DECLARE_MEMBERS(OdGeodeticTransformationDefinition);
  public:
    static OdResult load(const OdString& sCode, OdGeodeticTransformationDefinitionPtr& pGeodeticTransformationDefinition);
    
    static OdResult loadAll(OdGeodeticTransformationDefinitionArray& arrGeodeticTransformationDefinition);

    OdResult getSourceDatum(OdString& sSourceDatum) const;

    OdResult setSourceDatum(const OdString& sSourceDatum);

    OdResult getTargetDatum(OdString& sTargetDatum) const;

    OdResult setTargetDatum(const OdString& sTargetDatum);

    OdResult getGroup(OdString& sGroup) const;

    OdResult setGroup(const OdString& sGroup);

    OdResult getEpsgCode(OdInt16& nEpsgCode) const;

    OdResult setEpsgCode(OdInt16 nEpsgCode);

    OdResult isProtected(bool& bProtected) const;

    OdResult setProtected(bool bProtected);

    OdResult getEpsgVariation(OdInt16& nEpsgVariation) const;

    OdResult setEpsgVariation(OdInt16 nEpsgVariation);

    OdResult getInverseSupported(bool& bInverseSupported) const;
    
    OdResult setInverseSupported(bool bInverseSupported);

    OdResult getMaxIterations(OdInt16& nMaxIterations) const;

    OdResult setMaxIterations(OdInt16 nMaxIterations);

    OdResult getConvergenceValue(double& dConvergenceValue) const;

    OdResult setConvergenceValue(double dConvergenceValue);

    OdResult getErrorValue(double& dErrorValue) const;

    OdResult setErrorValue(double dErrorValue);

    OdResult getAccuracy(double& dAccuracy) const;

    OdResult setAccuracy(double dAccuracy);

    OdResult getRangeMinLongitude(double& dValue) const;

    OdResult setRangeMinLongitude(double dValue);

    OdResult getRangeMaxLongitude(double& dValue) const;

    OdResult setRangeMaxLongitude(double dValue);

    OdResult getRangeMinLatitude(double& dValue) const;

    OdResult setRangeMinLatitude(double dValue);

    OdResult getRangeMaxLatitude(double& dValue) const;

    OdResult setRangeMaxLatitude(double dValue);

    OdResult getTransformationDefType(TransformationDefType& eType) const;

    OdResult getParameters(OdGeodeticTransformationParametersPtr& pParameters) const;
    
    OdResult setParameters(const OdGeodeticTransformationParameters* pParameters);

    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_ODGEODETICTRANSFORMATIONDEFINITION_INCLUDED_