OdDefinitionBase.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_ODDEFINITIONBASE_INCLUDED_
#define _ODSPATIALREFERENCE_ODDEFINITIONBASE_INCLUDED_
 
#include "OdSpatialReference.h"
 
namespace OdSpatialReference
{
  enum DefinitionType
  {
    kUnknown = 0,
    kEllipsoid,
    kDatum,
    kCoordinateReferenceSystem,
    kGeodeticTransformation,
    kGeodeticPath,
    kCategory,
    kVerticalCoordinateReferenceSystem,
    kVerticalDatum
  };
 
  class OdDefinitionBaseImpl;

  class TD_SPATIALREFERENCE_API OdDefinitionBase : public OdRxObject
  {
    ODSPREF_RX_WITH_IMPL_DECLARE_MEMBERS(OdDefinitionBase);
  public:
    void initialize(bool bReset = false);

    OdResult update();

    OdResult remove();

    DefinitionType getDefinitionType() const;
    
    OdResult getCode(OdString& sCode) const;

    OdResult setCode(const OdString & sCode);

    OdResult getDescription(OdString& sDescription) const;

    OdResult setDescription(const OdString & sDescription);
    
    OdResult getSource(OdString& sSource) const;

    OdResult setSource(const OdString & sSource);
 
    virtual void copyFrom(const OdRxObject* pSource) ODRX_OVERRIDE;
  };

  typedef OdSmartPtr<OdDefinitionBase> OdDefinitionBasePtr;

  typedef OdArray<OdDefinitionBasePtr> OdDefinitionBaseArray;
}
 
#endif //_ODSPATIALREFERENCE_ODDEFINITIONBASE_INCLUDED_