TObj_OcafObjectIterator Class Reference

#include <TObj_OcafObjectIterator.hxx>

Inheritance diagram for TObj_OcafObjectIterator:

Public Member Functions
	TObj_OcafObjectIterator (const TDF_Label &theLabel, const occ::handle< Standard_Type > &theType=nullptr, const bool theRecursive=false, const bool theAllSubChildren=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 bool isRecursive=false)
	Creates an iterator an initialize it by theLabel and recursive flag. If isRecursive is true make recursive iterations.
bool	More () const override
	Returns True if there is a current Item in the iteration.
void	Next () override
	Move to the next Item.
occ::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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
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 bool isRecursive=false)
	Initialize Iterator by the theLabel.

Protected Attributes
occ::handle< Standard_Type >	myType
	type of objects to iterate on
bool	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.
occ::handle< TObj_Object >	myObject
	Current Object.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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 occ::handle< Standard_Type > &	theType = nullptr,
		const bool	theRecursive = false,
		const bool	theAllSubChildren = 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()

void TObj_OcafObjectIterator::MakeStep ( )

overrideprotectedvirtual

Shift iterator to the next object.

Implements TObj_LabelIterator.

Field Documentation

myAllSubChildren

bool TObj_OcafObjectIterator::myAllSubChildren

protected

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

myType

occ::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