#include <TObj_OcafObjectIterator.hxx>

Inheritance diagram for TObj_OcafObjectIterator:

[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.

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.

virtual Standard_Boolean	More () const override
	Returns True if there is a current Item in the iteration.

virtual void	Next () override
	Move to the next Item.

virtual Handle< TObj_Object >	Value () const override
	Returns the current item.

const TDF_Label &	LabelValue () const
	Returns the label of the current item.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

Standard_Transient *	This () 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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
virtual void	MakeStep () override
	Shift iterator to the next object.

Protected Member Functions inherited from TObj_LabelIterator
	TObj_LabelIterator ()
	Creates an Empty Iterator.

void	Init (const TDF_Label &theLabel, const Standard_Boolean isRecursive=Standard_False)
	Initialize Iterator by the theLabel.

Protected Attributes
Handle< Standard_Type >	myType
	type of objects to iterate on

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

Protected Attributes inherited from TObj_LabelIterator
TDF_Label	myNode
	Current node.

TDF_ChildIterator	myIterator
	OCAF Child iterator.

Handle< TObj_Object >	myObject
	Current Object.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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

theLabel	start label for searching
theType	type of the found objects, or all types if Null
theRecursive	search children recursively, not only on sub-labels of theLabel
theAllSubChildren	do 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:

TObj_OcafObjectIterator.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members