DbDictionary.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 _ODDBDICTIONARY_INCLUDED_
#define _ODDBDICTIONARY_INCLUDED_
 
#include "TD_PackPush.h"
 
#include "RxIterator.h"
#include "RxDefs.h"
#include "DbObject.h"
#include "DwgDeclareMembers.h"
 
class OdDbDictionaryImpl;
class OdDbObjectId;
class OdString;

class TOOLKIT_EXPORT OdDbDictionaryIterator : public OdRxIterator
{
public:
  ODRX_DECLARE_MEMBERS(OdDbDictionaryIterator);
 
  virtual ~OdDbDictionaryIterator() {}

  virtual OdString name() const = 0;

  virtual OdDbObjectPtr getObject(
    OdDb::OpenMode openMode = OdDb::kForRead) = 0;

  virtual OdDbObjectId objectId() const = 0;

  virtual bool setPosition(
    OdDbObjectId objectId) = 0;

  virtual OdRxObjectPtr object() const;
 
protected:
  
  OdDbDictionaryIterator() {}
};

typedef OdSmartPtr<OdDbDictionaryIterator> OdDbDictionaryIteratorPtr;

class TOOLKIT_EXPORT OdDbDictionary : public OdDbObject
{
  DWGMAP_DECLARE_MEMBERS(OdDbDictionary);
 
protected:
  OdDbDictionary();
 
public:
  OdDbObjectPtr getAt(
    const OdString& name, 
    OdDb::OpenMode mode) const;
  
  OdDbObjectId getAt(
    const OdString& name, 
    OdResult* pStatus = 0) const;

  OdString nameAt(
    const OdDbObjectId& objectId) const;

  bool has(
    const OdString& name) const;
    
  bool has(
    const OdDbObjectId& objectId) const;

  OdUInt32 numEntries() const;

  OdDbObjectId remove(
    const OdString& name);
    
  void remove(
    const OdDbObjectId& objectId);

  bool setName(
    const OdString& oldName, 
    const OdString& newName);

  OdDbObjectId setAt(
    const OdString& name, 
    OdDbObject* newValue);

  bool isTreatElementsAsHard() const;

  void setTreatElementsAsHard(
    bool doIt);

  OdDbDictionaryIteratorPtr newIterator(
    OdRx::DictIterType iterType = OdRx::kDictCollated) const;

  OdDbNextIteratorWrap<OdDbDictionaryIterator> begin() const {
    return OdDbNextIteratorWrap<OdDbDictionaryIterator>(newIterator());
  }

  OdDbNextIteratorWrap<OdDbDictionaryIterator> end() const {
    return OdDbNextIteratorWrap<OdDbDictionaryIterator>(OdDbDictionaryIteratorPtr());
  }
 
  enum 
  { 
    kMaxSuggestNameSize = 2049 
  };
  OdString suggestName(const OdString& strFilePath, const int nMaxLength = kMaxSuggestNameSize) const;
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;

  virtual OdDb::DuplicateRecordCloning mergeStyle() const;

  virtual void setMergeStyle(
    OdDb::DuplicateRecordCloning mergeStyle);
 
  virtual void goodbye(
    const OdDbObject* pObject);
 
  virtual void erased(
    const OdDbObject* pObject, 
    bool erasing = true);
 
  virtual OdResult subGetClassID(
    void* pClsid) const;
 
  virtual void applyPartialUndo(
    OdDbDwgFiler* pFiler,
    OdRxClass* pClass);
 
  virtual void subClose();
};

typedef OdSmartPtr<OdDbDictionary> OdDbDictionaryPtr;
 
#include "TD_PackPop.h"
 
#endif