DbObjectIterator.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 _ODDBOBJECTITERATOR_INCLUDED_
#define _ODDBOBJECTITERATOR_INCLUDED_
 
#include "RxObject.h"
#include "DbObjectId.h"
#include "DbRangeIterator.h"
 
class OdDbEntity;
typedef OdSmartPtr<OdDbEntity> OdDbEntityPtr;

class TOOLKIT_EXPORT OdDbObjectIterator : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbObjectIterator);
 
  OdDbObjectIterator() {}

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

  virtual bool done() const = 0;

  virtual OdDbObjectId objectId() const = 0;

  virtual OdDbEntityPtr entity(
    OdDb::OpenMode openMode = OdDb::kForRead, 
    bool openErasedEntity = false) const = 0;

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

    virtual bool seek(
    OdDbObjectId objectId) = 0;
    
  virtual bool seek(
    const OdDbEntity* pEntity) = 0;
};

typedef OdSmartPtr<OdDbObjectIterator> OdDbObjectIteratorPtr;
 
#endif //_ODDBOBJECTITERATOR_INCLUDED_