OdCategoryDefinition.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_ODCATEGORYDEFINITION_INCLUDED_
#define _ODSPATIALREFERENCE_ODCATEGORYDEFINITION_INCLUDED_
 
#include "OdDefinitionBase.h"

namespace OdSpatialReference
{
  class OdCategoryDefinition;

  typedef OdSmartPtr<OdCategoryDefinition> OdCategoryDefinitionPtr;

  typedef OdArray<OdCategoryDefinitionPtr> OdCategoryDefinitionArray;
 
  class OdCategoryDefinitionImpl;

  class TD_SPATIALREFERENCE_API OdCategoryDefinition : public OdDefinitionBase
  {
    ODSPREF_RX_DECLARE_MEMBERS(OdCategoryDefinition);
  public:
    static OdResult load(const OdString& sCode, OdCategoryDefinitionPtr& pCategoryDefinition);

    static OdResult loadAll(OdCategoryDefinitionArray& arrCD);

    static OdResult loadAll(const OdString& sCsCode, OdCategoryDefinitionArray& arrCD);

    static OdResult loadAllVertical(const OdString& sVcsCode, OdCategoryDefinitionArray& arrCD);

    OdResult getCount(OdUInt32 & uCount) const;

    OdResult getAt(OdUInt32 uIndex, OdString& sCode) const;

    OdResult add(const OdString& sCode);

    OdResult remove(const OdString& sCode);

    OdResult clear();
    
    OdResult contains(const OdString& sCode, bool & bContains) const;

    OdResult getVerticalCount(OdUInt32& uCount) const;

    OdResult getVerticalAt(OdUInt32 uIndex, OdString& sCode) const;

    OdResult addVertical(const OdString& sCode);

    OdResult removeVertical(const OdString& sCode);

    OdResult clearVertical();

    OdResult containsVertical(const OdString& sCode, bool& bContains) const;

    OdResult isProtected(bool& bProtected) const;

    OdResult setProtected(bool bProtected);

    static bool isLegalCode(const OdString& sCode);
 
    using OdDefinitionBase::remove;
  };
}
 
#endif //_ODSPATIALREFERENCE_ODCATEGORYDEFINITION_INCLUDED_