Open CASCADE Technology  7.1.0.beta
Public Member Functions | Protected Member Functions | Protected Attributes

TObj_LabelIterator Class Referenceabstract

#include <TObj_LabelIterator.hxx>

Inheritance diagram for TObj_LabelIterator:
Inheritance graph
[legend]

Public Member Functions

 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 MMgt_TShared
virtual void Delete () const override
 Memory deallocator for transient classes. 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 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

 TObj_LabelIterator ()
 Creates an Empty Iterator. More...
 
virtual void MakeStep ()=0
 Shifts iterator to the next object. More...
 
void Init (const TDF_Label &theLabel, const Standard_Boolean isRecursive=Standard_False)
 Initialize Iterator by the theLabel. More...
 

Protected Attributes

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 is a basis for OCAF based iterators.

Constructor & Destructor Documentation

TObj_LabelIterator::TObj_LabelIterator ( )
protected

Creates an Empty Iterator.

Constructor

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.

Constructor

Member Function Documentation

void TObj_LabelIterator::Init ( const TDF_Label theLabel,
const Standard_Boolean  isRecursive = Standard_False 
)
inlineprotected

Initialize Iterator by the theLabel.

Internal methods

const TDF_Label& TObj_LabelIterator::LabelValue ( ) const
inline

Returns the label of the current item.

virtual void TObj_LabelIterator::MakeStep ( )
protectedpure virtual

Shifts iterator to the next object.

Iterating methods

Implemented in TObj_OcafObjectIterator, and TObj_ReferenceIterator.

virtual Standard_Boolean TObj_LabelIterator::More ( void  ) const
inlineoverridevirtual

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

Redefined methods

Reimplemented from TObj_ObjectIterator.

virtual void TObj_LabelIterator::Next ( )
overridevirtual

Move to the next Item.

Reimplemented from TObj_ObjectIterator.

virtual Handle< TObj_Object > TObj_LabelIterator::Value ( ) const
inlineoverridevirtual

Returns the current item.

Reimplemented from TObj_ObjectIterator.

Field Documentation

TDF_ChildIterator TObj_LabelIterator::myIterator
protected

OCAF Child iterator.

TDF_Label TObj_LabelIterator::myNode
protected

Current node.

Fields

Handle< TObj_Object > TObj_LabelIterator::myObject
protected

Current Object.


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