CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
OdBrComplexShellTraverser Class Reference

#include <BrComplexShellTraverser.h>

Inheritance diagram for OdBrComplexShellTraverser:
OdBrTraverser

Public Member Functions

 OdBrComplexShellTraverser ()
 
OdBrErrorStatus setComplex (const OdBrComplex &complex)
 
OdBrErrorStatus setShell (const OdBrShell &shell)
 
OdBrErrorStatus setComplexAndShell (const OdBrShell &shell)
 
OdBrShell getShell () const
 
OdBrComplex getComplex () const
 
- Public Member Functions inherited from OdBrTraverser
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
 

Additional Inherited Members

- Protected Member Functions inherited from OdBrTraverser
 OdBrTraverser ()
 
 OdBrTraverser (const OdBrTraverser &source)
 
- Protected Attributes inherited from OdBrTraverser
OdRxObjectPtr m_pImp
 
OdSharedPtr< OdDbStubPtrArraym_pFSubentPath
 
bool m_bIsValidate
 

Detailed Description

This class is the interface class for complex shell traversers.

See also
TD_Br

<group OdBr_Classes>

Definition at line 44 of file BrComplexShellTraverser.h.

Constructor & Destructor Documentation

◆ OdBrComplexShellTraverser()

OdBrComplexShellTraverser::OdBrComplexShellTraverser ( )

Member Function Documentation

◆ getComplex()

OdBrComplex OdBrComplexShellTraverser::getComplex ( ) const

Returns the owner of the shell list associated with this Traverser object.

◆ getShell()

OdBrShell OdBrComplexShellTraverser::getShell ( ) const

Returns the shell object at the current Traverser position.

◆ setComplex()

OdBrErrorStatus OdBrComplexShellTraverser::setComplex ( const OdBrComplex complex)

Sets this Traverser object to a specific complex shell list.

Parameters
complex[in] Owner of the shell list.
Remarks
This Traverser object is set to the first element in the list.

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

◆ setComplexAndShell()

OdBrErrorStatus OdBrComplexShellTraverser::setComplexAndShell ( const OdBrShell shell)

Sets this Traverser object to a specific complex shell list and starting position.

Parameters
shell[in] Defines the shell list and starting position.

◆ setShell()

OdBrErrorStatus OdBrComplexShellTraverser::setShell ( const OdBrShell shell)

Sets the starting position of this Traverser object.

Parameters
shell[in] Defines the starting position.

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