///////////////////////////////////////////////////////////////////////////////
|
// Copyright (C) 2002-2016, 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 Teigha(R) software pursuant to a license
|
// agreement with Open Design Alliance.
|
// Teigha(R) Copyright (C) 2002-2016 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;
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdDbBlockIterator object pointers.
|
*/
|
typedef OdSmartPtr<OdDbBlockIterator> OdDbBlockIteratorPtr;
|
|
/** \details
|
This class implements Iterator objects that traverse entries in OdDbBlockTableRecord objects in an OdDbDatabase instance.
|
|
\remarks
|
Instances are returned by OdDbBlockTableRecord::newIterator().
|
|
<group OdDb_Classes>
|
*/
|
class TOOLKIT_EXPORT OdDbBlockIterator : public OdRxObject
|
{
|
protected:
|
OdDbBlockIterator() {}
|
public:
|
ODRX_DECLARE_MEMBERS(OdDbBlockIterator);
|
|
/** \details
|
Sets this Iterator object to reference the OdDbBlock that it would normally return first.
|
|
\remarks
|
Allows multiple traversals of the Iterator list.
|
*/
|
virtual void start() = 0;
|
|
/** \details
|
Returns the Object ID of the next object, and increments this Iterator object.
|
*/
|
virtual OdDbObjectId next() = 0;
|
|
/** \details
|
Returns the Object ID of the record currently referenced by this Iterator object.
|
*/
|
virtual OdDbObjectId id() const = 0;
|
|
/** \details
|
Positions this Iterator object at the specified record.
|
\param objectId [in] Object ID of the record.
|
\remarks
|
Returns true if and only if successful.
|
*/
|
virtual bool seek(
|
OdDbObjectId objectId) = 0;
|
|
/** \details
|
Returns an Iterator object that can be used to traverse the specified Block Table Record.
|
|
\param pBtr [in] Pointer the Block Table Record to traverse.
|
*/
|
static OdDbBlockIteratorPtr newBlockIterator(
|
const OdDbBlockTableRecord* pBtr);
|
|
/** \details
|
Returns an Iterator object that can be used to traverse queries defined by OdDbFilter objects
|
applied to the specified Block Table Record.
|
|
\param pBtr [in] Pointer the Block Table Record to traverse.
|
\param pFilter [in] Pointer to the filter.
|
*/
|
static OdDbBlockIteratorPtr newFilteredIterator(
|
const OdDbBlockTableRecord* pBtr,
|
const OdDbFilter* pFilter);
|
|
/** \details
|
Returns an Iterator object that can be used to traverse queries defined by an
|
array of OdDbFilter objects
|
applied to the specified Block Table Record.
|
|
\param pBtr [in] Pointer the Block Table Record to traverse.
|
\param filters [in] Array of pointers to filter objects.
|
*/
|
static OdDbBlockIteratorPtr newCompositeIterator(
|
const OdDbBlockTableRecord* pBtr,
|
const OdArray<OdSmartPtr<OdDbFilter> >& filters);
|
|
};
|
/** \details
|
This class implements Iterator objects that traverse queries defined by OdDbFilter objects
|
on Block Table Records.
|
|
\sa
|
TD_Db
|
|
\remarks
|
This class is used by OdDbCompositeFilteredBlockIterator.
|
<group OdDb_Classes>
|
*/
|
class TOOLKIT_EXPORT OdDbFilteredBlockIterator : public OdDbBlockIterator
|
{
|
protected:
|
OdDbFilteredBlockIterator() {}
|
public:
|
ODRX_DECLARE_MEMBERS(OdDbFilteredBlockIterator);
|
|
/** \details
|
Returns the estimated fraction [0.0 .. 1.0] of the contents that will
|
be selected by the OdDbFilter query.
|
|
\remarks
|
Used to order the OdDbFilteredBlockIterator objects during a block traversal.
|
|
* 0.0 forces the iterator to be used first.
|
* 1.0 forces the iterator to be used last.
|
|
The filters with the fewest hits will be applied first.
|
*/
|
virtual double estimatedHitFraction() const = 0;
|
|
/** \details
|
Returns true if and only if specified object passes the OdDbFilter query.
|
|
\param objectId [in] Object ID of the entity to be tested.
|
*/
|
virtual bool accepts(
|
OdDbObjectId objectId) const = 0;
|
|
/** \details
|
Returns true if and only if the Index iterator, when not the primary iterator,
|
is to buffer its output.
|
|
\remarks
|
When false, only the first index/filter pair is traversed, with subsequent pairs
|
queried via accepts().
|
|
If true, after all the IDs from the previous
|
iterator have been added to the buffer, the start(), next() and id() of this iterator are be used
|
iterate through the data.
|
*/
|
virtual bool buffersForComposition() const;
|
|
/** \details
|
Adds the specified Object ID to the buffer of an Index iterator.
|
|
\param objectId [in] Object ID of the entity to be added.
|
|
\sa
|
buffersForComposition
|
*/
|
virtual void addToBuffer(
|
OdDbObjectId objectId);
|
};
|
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdDbFilteredBlockIterator object pointers.
|
*/
|
typedef OdSmartPtr<OdDbFilteredBlockIterator> OdDbFilteredBlockIteratorPtr;
|
|
|
#endif // ODDBBLOCKITERATOR_H
|
