DbSymbolTable.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 _ODDBSYMBOLTABLE_INCLUDED
#define _ODDBSYMBOLTABLE_INCLUDED
 
#include "TD_PackPush.h"
 
#include "DbObject.h"
#include "DbRangeIterator.h"
 
class OdDbSymbolTableRecord;
class OdDbSymbolTableIterator;
class OdDbRecordIdCollectionView;
class OdDbRecordCollectionView;

typedef OdSmartPtr<OdDbSymbolTableIterator> OdDbSymbolTableIteratorPtr;
typedef OdSmartPtr<OdDbSymbolTableRecord> OdDbSymbolTableRecordPtr;
 

class TOOLKIT_EXPORT OdError_DuplicateRecordName : public OdError
{
public:
  OdError_DuplicateRecordName(   
    OdDbObjectId existingRecId);
  OdDbObjectId existingRecordId() const;
};

class TOOLKIT_EXPORT OdDbSymbolTable : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbSymbolTable);

  OdDbSymbolTable();

  virtual OdDbSymbolTableRecordPtr getAt(
    const OdString& sName,
    OdDb::OpenMode openMode, 
    bool getErasedRecord = false) const;

  virtual OdDbObjectId getAt(
    const OdString& sName, 
    bool getErasedRecord = false) const;
 

  virtual bool has( const OdString& sName ) const;
  
  virtual bool has( const OdDbObjectId& objectId ) const;
 

  virtual OdDbSymbolTableIteratorPtr newIterator( 
    bool atBeginning = true, 
    bool skipDeleted = true) const;

  inline OdDbRecordIdCollectionView ids(bool atBeginning = true, bool skipDeleted = true);

  inline OdDbRecordCollectionView records(bool atBeginning = true, bool skipDeleted = true);

  virtual OdDbObjectId add( OdDbSymbolTableRecord* pRecord );
 
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  virtual OdResult dxfIn(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOut(
    OdDbDxfFiler* pFiler) const;
 
  virtual OdResult dxfInFields_R12(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields_R12(
    OdDbDxfFiler* pFiler) const;
};

typedef OdSmartPtr<OdDbSymbolTable> OdDbSymbolTablePtr;
 
 
 
class OdDbSymbolTableIteratorImpl;

class TOOLKIT_EXPORT OdDbSymbolTableIterator : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbSymbolTableIterator);

    virtual void start(
    bool atBeginning = true, 
    bool skipErased = true);

    virtual bool done() const;

  virtual OdDbObjectId getRecordId() const;

  virtual OdDbSymbolTableRecordPtr getRecord(
    OdDb::OpenMode openMode = OdDb::kForRead,
    bool openErasedRecord = false) const;

  virtual void step(
    bool forward = true, 
    bool skipErased = true);

    virtual void seek(
    const OdDbObjectId& ObjectId);
    
  virtual void seek(
    const OdDbSymbolTableRecord* pRecord);
 
  virtual ~OdDbSymbolTableIterator();
protected:
  friend class OdDbSymbolTable;
 
  OdDbSymbolTableIterator();
  OdDbSymbolTableIterator(
    OdDbSymbolTableIteratorImpl* pImpl);
 
  OdDbSymbolTableIteratorImpl* m_pImpl;
};
 
#include <DbSymbolTableRecord.h>
//DOM-IGNORE-BEGIN
class OdDbRecordIdCollectionView
{
  OdDbSymbolTableIteratorPtr m_pIterator;
public:
  struct Iterator : OdDbStepIteratorWrap<OdDbSymbolTableIterator>
  {
    using value_type = OdDbObjectId;
    using reference = OdDbObjectId;
    Iterator(const OdDbSymbolTableIteratorPtr& i) : OdDbStepIteratorWrap<OdDbSymbolTableIterator>(i) {}
    reference operator*() const { return m_pIterator->getRecordId(); }
  };
  OdDbRecordIdCollectionView(const OdDbSymbolTableIteratorPtr& i) : m_pIterator(i) {}
  Iterator begin() const { return Iterator(m_pIterator); }
  Iterator end() const { return Iterator(OdDbSymbolTableIteratorPtr()); }
};
 
class OdDbRecordCollectionView
{
  OdDbSymbolTableIteratorPtr m_pIterator;
public:
  struct Iterator : OdDbStepIteratorWrap<OdDbSymbolTableIterator>
  {
    using value_type = OdDbSymbolTableRecordPtr;
    using reference = OdDbSymbolTableRecordPtr;
    Iterator(const OdDbSymbolTableIteratorPtr& i) : OdDbStepIteratorWrap<OdDbSymbolTableIterator>(i) {}
    OdDbSymbolTableRecordPtr operator*() const { return m_pIterator->getRecord(); }
  };
  OdDbRecordCollectionView(const OdDbSymbolTableIteratorPtr& i) : m_pIterator(i) {}
  Iterator begin() const { return Iterator(m_pIterator); }
  Iterator end() const { return Iterator(OdDbSymbolTableIteratorPtr()); }
};
 
OdDbRecordIdCollectionView OdDbSymbolTable::ids(bool atBeginning, bool skipDeleted)
{
  return OdDbRecordIdCollectionView(newIterator(atBeginning, skipDeleted));
}
 
OdDbRecordCollectionView OdDbSymbolTable::records(bool atBeginning, bool skipDeleted)
{
  return OdDbRecordCollectionView(newIterator(atBeginning, skipDeleted));
}
//DOM-IGNORE-END
 
 
#include "TD_PackPop.h"
 
#endif // _ODDBSYMBOLTABLE_INCLUDED