TObj_LabelIterator Class Reference

#include <TObj_LabelIterator.hxx>

Inheritance diagram for TObj_LabelIterator:

Public Member Functions
	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
	TObj_LabelIterator ()
	Creates an Empty Iterator.
virtual void	MakeStep ()=0
	Shifts iterator to the next object.
void	Init (const TDF_Label &theLabel, const bool isRecursive=false)
	Initialize Iterator by the theLabel.

Protected Attributes
TDF_Label	myNode
	Current node.
TDF_ChildIterator	myIterator
	OCAF Child iterator.
occ::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 is a basis for OCAF based iterators.

Constructor & Destructor Documentation

TObj_LabelIterator() [1/2]

TObj_LabelIterator::TObj_LabelIterator ( )

protected

Creates an Empty Iterator.

Constructor

TObj_LabelIterator() [2/2]

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.

Constructor

Member Function Documentation

Init()

void TObj_LabelIterator::Init ( const TDF_Label & theLabel, const bool isRecursive = false )

inlineprotected

Initialize Iterator by the theLabel.

Internal methods

LabelValue()

const TDF_Label & TObj_LabelIterator::LabelValue ( ) const

inline

Returns the label of the current item.

MakeStep()

virtual void TObj_LabelIterator::MakeStep ( )

protectedpure virtual

Shifts iterator to the next object.

Iterating methods

Implemented in TObj_OcafObjectIterator, and TObj_ReferenceIterator.

More()

bool TObj_LabelIterator::More ( ) const

inlineoverridevirtual

Returns True if there is a current Item in the iteration.

Redefined methods

Reimplemented from TObj_ObjectIterator.

Next()

void TObj_LabelIterator::Next ( )

overridevirtual

Move to the next Item.

Reimplemented from TObj_ObjectIterator.

Value()

occ::handle< TObj_Object > TObj_LabelIterator::Value ( ) const

inlineoverridevirtual

Returns the current item.

Reimplemented from TObj_ObjectIterator.

Field Documentation

myIterator

TDF_ChildIterator TObj_LabelIterator::myIterator

protected

OCAF Child iterator.

myNode

TDF_Label TObj_LabelIterator::myNode

protected

Current node.

Fields

myObject

occ::handle<TObj_Object> TObj_LabelIterator::myObject

protected

Current Object.

---

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

• TObj_LabelIterator.hxx