DbBlockIterator.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 ODDBBLOCKITERATOR_H
#define ODDBBLOCKITERATOR_H
 
#include "RxObject.h"
#include "OdArrayPreDef.h"
 
class OdDbObjectId;
class OdDbFilter;
class OdDbBlockTableRecord;
class OdDbBlockIterator;
 
typedef OdSmartPtr<OdDbBlockIterator> OdDbBlockIteratorPtr;
 
class  TOOLKIT_EXPORT OdDbBlockIterator : public OdRxObject
{
protected: 
  OdDbBlockIterator() {}
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdDbBlockIterator);
  //DOM-IGNORE-END
 
    virtual void start() = 0;
 
  virtual OdDbObjectId next() = 0;
 
  virtual OdDbObjectId id() const = 0;
 
  virtual bool seek(
    OdDbObjectId objectId) = 0;
 
  static OdDbBlockIteratorPtr newBlockIterator(
    const OdDbBlockTableRecord* pBtr);
 
  static OdDbBlockIteratorPtr newFilteredIterator(
      const OdDbBlockTableRecord* pBtr,
      const OdDbFilter* pFilter);
 
  static OdDbBlockIteratorPtr newCompositeIterator(
      const OdDbBlockTableRecord* pBtr,
      const OdArray<OdSmartPtr<OdDbFilter> >& filters);
 
};
 
class  TOOLKIT_EXPORT OdDbFilteredBlockIterator : public OdDbBlockIterator
{
protected:
  OdDbFilteredBlockIterator() {}
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdDbFilteredBlockIterator);
  //DOM-IGNORE-END
 
  virtual double estimatedHitFraction() const = 0;
 
  virtual bool accepts(
    OdDbObjectId objectId) const = 0;
 
  virtual bool buffersForComposition() const;
 
  virtual void addToBuffer(
    OdDbObjectId objectId);
};
 
typedef OdSmartPtr<OdDbFilteredBlockIterator> OdDbFilteredBlockIteratorPtr;
 
 
#endif // ODDBBLOCKITERATOR_H