Open CASCADE Technology  7.3.1.dev
Public Types | Public Member Functions
NCollection_EBTree< TheObjType, TheBndType > Class Template Reference

#include <NCollection_EBTree.hxx>

Inheritance diagram for NCollection_EBTree< TheObjType, TheBndType >:
Inheritance graph
[legend]

Public Types

typedef NCollection_UBTree< TheObjType, TheBndType > UBTree
 
typedef TYPENAME UBTree::TreeNode TreeNode
 

Public Member Functions

 NCollection_EBTree (const Handle< NCollection_BaseAllocator > &theAllocator=0L)
 
Standard_Boolean Add (const TheObjType &theObj, const TheBndType &theBnd) override
 
Standard_Boolean Remove (const TheObjType &theObj)
 
Standard_Boolean Contains (const TheObjType &theObj) const
 
const TreeNodeFindNode (const TheObjType &theObj) const
 
void Clear (const Handle< NCollection_BaseAllocator > &aNewAlloc=0L) override
 
- Public Member Functions inherited from NCollection_UBTree< TheObjType, TheBndType >
 NCollection_UBTree ()
 
 NCollection_UBTree (const Handle< NCollection_BaseAllocator > &theAllocator)
 
virtual Standard_Integer Select (Selector &theSelector) const
 
Standard_Boolean IsEmpty () const
 
const TreeNodeRoot () const
 
virtual ~NCollection_UBTree ()
 
const Handle< NCollection_BaseAllocator > & Allocator () const
 

Additional Inherited Members

- Protected Member Functions inherited from NCollection_UBTree< TheObjType, TheBndType >
TreeNodeChangeLastNode ()
 
Standard_Integer Select (const TreeNode &theBranch, Selector &theSelector) const
 

Detailed Description

template<class TheObjType, class TheBndType>
class NCollection_EBTree< TheObjType, TheBndType >

The algorithm of unbalanced binary tree of overlapped bounding boxes with the possibility of deleting objects from the tree.

In addition to the requirements to the object type defined in the parent class this class requires that the object can be hashed and compared to another object (functions HashCode and IsEqual are defined for it), since the class NCollection_DataMap is used where the object plays the role of the key.

Member Typedef Documentation

◆ TreeNode

template<class TheObjType, class TheBndType>
typedef TYPENAME UBTree::TreeNode NCollection_EBTree< TheObjType, TheBndType >::TreeNode

◆ UBTree

template<class TheObjType, class TheBndType>
typedef NCollection_UBTree<TheObjType, TheBndType> NCollection_EBTree< TheObjType, TheBndType >::UBTree

Constructor & Destructor Documentation

◆ NCollection_EBTree()

template<class TheObjType, class TheBndType>
NCollection_EBTree< TheObjType, TheBndType >::NCollection_EBTree ( const Handle< NCollection_BaseAllocator > &  theAllocator = 0L)
inline

Constructor.

Member Function Documentation

◆ Add()

template<class TheObjType, class TheBndType>
Standard_Boolean NCollection_EBTree< TheObjType, TheBndType >::Add ( const TheObjType &  theObj,
const TheBndType &  theBnd 
)
inlineoverridevirtual

Updates the tree with a new object and its bounding box. Extends the functionality of the parent method by maintaining the map myObjNodeMap. Redefined virtual method.

Returns
False if the tree already contains theObj.

Reimplemented from NCollection_UBTree< TheObjType, TheBndType >.

◆ Clear()

template<class TheObjType, class TheBndType>
void NCollection_EBTree< TheObjType, TheBndType >::Clear ( const Handle< NCollection_BaseAllocator > &  aNewAlloc = 0L)
inlineoverridevirtual

Clears the contents of the tree. Redefined virtual method

Reimplemented from NCollection_UBTree< TheObjType, TheBndType >.

◆ Contains()

template<class TheObjType, class TheBndType>
Standard_Boolean NCollection_EBTree< TheObjType, TheBndType >::Contains ( const TheObjType &  theObj) const
inline
Returns
True if the tree contains the object.

◆ FindNode()

template<class TheObjType, class TheBndType>
const TreeNode& NCollection_EBTree< TheObjType, TheBndType >::FindNode ( const TheObjType &  theObj) const
inline
Returns
The leaf node containing the object.

◆ Remove()

template<class TheObjType, class TheBndType >
Standard_Boolean NCollection_EBTree< TheObjType, TheBndType >::Remove ( const TheObjType &  theObj)

Removes the given object and updates the tree.

Returns
False if the tree does not contain theObj

The documentation for this class was generated from the following file: