Open CASCADE Technology 7.8.0
Public Member Functions | Protected Member Functions | Protected Attributes
TObj_ModelIterator Class Reference

#include <TObj_ModelIterator.hxx>

Inheritance diagram for TObj_ModelIterator:
Inheritance graph
[legend]

Public Member Functions

 TObj_ModelIterator (const Handle< TObj_Model > &theModel)
 Creates Iterator and initialize it by Model`s label.
 
virtual Standard_Boolean More () const override
 Returns True if iteration is not finished and method Value() will give the object.
 
virtual void Next () override
 Iterates to the next object.
 
virtual Handle< TObj_ObjectValue () const override
 Returns current object (or MainObj of Model if iteration has finished)
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (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_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.
 
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 addIterator (const Handle< TObj_Object > &theObj)
 Add iterator on children of indicated object recursively.
 

Protected Attributes

Handle< TObj_ObjectmyObject
 Current object.
 
TObj_SequenceOfIterator myIterSeq
 Sequence of iterators in model.
 

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 charget_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 all objects in the model.

Constructor & Destructor Documentation

◆ TObj_ModelIterator()

TObj_ModelIterator::TObj_ModelIterator ( const Handle< TObj_Model > &  theModel)

Creates Iterator and initialize it by Model`s label.

Constructor

Member Function Documentation

◆ addIterator()

virtual void TObj_ModelIterator::addIterator ( const Handle< TObj_Object > &  theObj)
protectedvirtual

Add iterator on children of indicated object recursively.

private methods

◆ More()

virtual Standard_Boolean TObj_ModelIterator::More ( ) const
overridevirtual

Returns True if iteration is not finished and method Value() will give the object.

Methods to iterate on objects.

Reimplemented from TObj_ObjectIterator.

◆ Next()

virtual void TObj_ModelIterator::Next ( )
overridevirtual

Iterates to the next object.

Reimplemented from TObj_ObjectIterator.

◆ Value()

virtual Handle< TObj_Object > TObj_ModelIterator::Value ( ) const
overridevirtual

Returns current object (or MainObj of Model if iteration has finished)

Reimplemented from TObj_ObjectIterator.

Field Documentation

◆ myIterSeq

TObj_SequenceOfIterator TObj_ModelIterator::myIterSeq
protected

Sequence of iterators in model.

◆ myObject

Handle< TObj_Object > TObj_ModelIterator::myObject
protected

Current object.

Fields


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