Open CASCADE Technology  7.5.0
Public Member Functions | Protected Member Functions | Protected Attributes

TObj_OcafObjectIterator Class Reference

#include <TObj_OcafObjectIterator.hxx>

Inheritance diagram for TObj_OcafObjectIterator:
Inheritance graph
[legend]

Public Member Functions

 TObj_OcafObjectIterator (const TDF_Label &theLabel, const Handle< Standard_Type > &theType=NULL, const Standard_Boolean theRecursive=Standard_False, const Standard_Boolean theAllSubChildren=Standard_False)
 Creates the iterator on TObj objects on the sub-labels of theLabel. More...
 
- Public Member Functions inherited from TObj_LabelIterator
 TObj_LabelIterator (const TDF_Label &theLabel, const Standard_Boolean isRecursive=Standard_False)
 Creates an iterator an initialize it by theLabel and recursive flag. If isRecursive is Standard_True make recursive iterations. More...
 
virtual Standard_Boolean More () const override
 Returns True if there is a current Item in the iteration. More...
 
virtual void Next () override
 Move to the next Item. More...
 
virtual Handle< TObj_ObjectValue () const override
 Returns the current item. More...
 
const TDF_LabelLabelValue () const
 Returns the label of the current item. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

virtual void MakeStep () override
 Shift iterator to the next object. More...
 
- Protected Member Functions inherited from TObj_LabelIterator
 TObj_LabelIterator ()
 Creates an Empty Iterator. More...
 
void Init (const TDF_Label &theLabel, const Standard_Boolean isRecursive=Standard_False)
 Initialize Iterator by the theLabel. More...
 

Protected Attributes

Handle< Standard_TypemyType
 type of objects to iterate on More...
 
Standard_Boolean myAllSubChildren
 to iterate all sub-children, do not stop on the first level More...
 
- Protected Attributes inherited from TObj_LabelIterator
TDF_Label myNode
 Current node. More...
 
TDF_ChildIterator myIterator
 OCAF Child iterator. More...
 
Handle< TObj_ObjectmyObject
 Current Object. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

This class provides an iterator by objects in a partition. (implements TObj_ObjectIterator interface)

Constructor & Destructor Documentation

◆ TObj_OcafObjectIterator()

TObj_OcafObjectIterator::TObj_OcafObjectIterator ( const TDF_Label theLabel,
const Handle< Standard_Type > &  theType = NULL,
const Standard_Boolean  theRecursive = Standard_False,
const Standard_Boolean  theAllSubChildren = Standard_False 
)

Creates the iterator on TObj objects on the sub-labels of theLabel.

Parameters
theLabelstart label for searching
theTypetype of the found objects, or all types if Null
theRecursivesearch children recursively, not only on sub-labels of theLabel
theAllSubChildrendo not stop at the first level of children, but search for sub-children too

Member Function Documentation

◆ MakeStep()

virtual void TObj_OcafObjectIterator::MakeStep ( )
overrideprotectedvirtual

Shift iterator to the next object.

Implements TObj_LabelIterator.

Field Documentation

◆ myAllSubChildren

Standard_Boolean TObj_OcafObjectIterator::myAllSubChildren
protected

to iterate all sub-children, do not stop on the first level

◆ myType

Handle< Standard_Type > TObj_OcafObjectIterator::myType
protected

type of objects to iterate on


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