CFx SDK Documentation  2022 SP0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OdBrTraverser Class Reference

#include <BrTraverser.h>

Inheritance diagram for OdBrTraverser:
OdBrBrepComplexTraverser OdBrBrepEdgeTraverser OdBrBrepFaceTraverser OdBrBrepShellTraverser OdBrBrepVertexTraverser OdBrComplexShellTraverser OdBrEdgeLoopTraverser OdBrElement2dNodeTraverser OdBrFaceLoopTraverser OdBrLoopEdgeTraverser OdBrLoopVertexTraverser OdBrMesh2dElement2dTraverser OdBrShellFaceTraverser OdBrVertexEdgeTraverser OdBrVertexLoopTraverser

Public Member Functions

bool done () const
 
OdBrErrorStatus next ()
 
OdBrErrorStatus restart ()
 
virtual ~OdBrTraverser ()
 
bool isEqualTo (const OdBrTraverser *pOtherTraverser) const
 
bool isNull () const
 
OdBrErrorStatus setValidationLevel (const BrValidationLevel &level= *(BrValidationLevel *) NULL)
 
OdBrErrorStatus getValidationLevel (BrValidationLevel &level) const
 

Protected Member Functions

 OdBrTraverser ()
 
 OdBrTraverser (const OdBrTraverser &source)
 

Protected Attributes

OdRxObjectPtr m_pImp
 
OdSharedPtr< OdDbStubPtrArraym_pFSubentPath
 
bool m_bIsValidate
 

Friends

class OdBrTraverserInternals
 

Detailed Description

This class is the interface class for BREP traversers.

See also
TD_Br

<group OdBr_Classes>

Definition at line 45 of file BrTraverser.h.

Constructor & Destructor Documentation

◆ ~OdBrTraverser()

virtual OdBrTraverser::~OdBrTraverser ( )
virtual

◆ OdBrTraverser() [1/2]

OdBrTraverser::OdBrTraverser ( )
protected

◆ OdBrTraverser() [2/2]

OdBrTraverser::OdBrTraverser ( const OdBrTraverser source)
protected

Member Function Documentation

◆ done()

bool OdBrTraverser::done ( ) const

Returns true if and only if the full topological adjacency list has been traversed with the next() function.

◆ getValidationLevel()

OdBrErrorStatus OdBrTraverser::getValidationLevel ( BrValidationLevel level) const

◆ isEqualTo()

bool OdBrTraverser::isEqualTo ( const OdBrTraverser pOtherTraverser) const

Returns true if and only if the specified Traverser object is equivalent to this Traverser object.

Remarks
Two OdBrTraverser objects are equivalent if and only if they non-null, have the same topological adjacency list owner, and have the same list position.
Parameters
pOtherTraverser[in] Pointer to any OdBrTraverser object.

◆ isNull()

bool OdBrTraverser::isNull ( ) const

Returns true if and only if this Traverser object is empty.

◆ next()

OdBrErrorStatus OdBrTraverser::next ( )

Sets this Traverser object to reference the next object in the topological adjacency list.

Remarks
Adjacency lists are circular, ordered lists.

Returns odbrOK if successful, or an appropriate error code if not.

◆ restart()

OdBrErrorStatus OdBrTraverser::restart ( )

Sets this Traverser object to reference the object that it would normally return first.

◆ setValidationLevel()

OdBrErrorStatus OdBrTraverser::setValidationLevel ( const BrValidationLevel level = *(BrValidationLevel *) NULL)

Friends And Related Function Documentation

◆ OdBrTraverserInternals

friend class OdBrTraverserInternals
friend

Definition at line 102 of file BrTraverser.h.

Member Data Documentation

◆ m_bIsValidate

bool OdBrTraverser::m_bIsValidate
protected

Definition at line 96 of file BrTraverser.h.

◆ m_pFSubentPath

OdSharedPtr<OdDbStubPtrArray> OdBrTraverser::m_pFSubentPath
protected

Definition at line 95 of file BrTraverser.h.

◆ m_pImp

OdRxObjectPtr OdBrTraverser::m_pImp
protected

Definition at line 94 of file BrTraverser.h.


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