OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    TObj_SequenceIterator Class Reference

    #include <TObj_SequenceIterator.hxx>

    Inheritance diagram for TObj_SequenceIterator:

    Public Member Functions

     TObj_SequenceIterator (const occ::handle< NCollection_HSequence< occ::handle< TObj_Object > > > &theObjects, const occ::handle< Standard_Type > &theType=nullptr)
     Creates an iterator an initialize it by sequence of objects.
    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.
    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_SequenceIterator ()
     Creates an Empty Iterator.

    Protected Attributes

    int myIndex
     current index of object in sequence
    occ::handle< Standard_Type > myType
     type of object
    occ::handle< NCollection_HSequence< occ::handle< TObj_Object > > > myObjects
     sequence of objects

    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 is an iterator on sequence

    Constructor & Destructor Documentation

    ◆ TObj_SequenceIterator() [1/2]

    TObj_SequenceIterator::TObj_SequenceIterator ( )
    protected

    Creates an Empty Iterator.

    Constructor

    ◆ TObj_SequenceIterator() [2/2]

    TObj_SequenceIterator::TObj_SequenceIterator ( const occ::handle< NCollection_HSequence< occ::handle< TObj_Object > > > & theObjects,
    const occ::handle< Standard_Type > & theType = nullptr )

    Creates an iterator an initialize it by sequence of objects.

    Constructor

    Member Function Documentation

    ◆ More()

    bool TObj_SequenceIterator::More ( ) const
    overridevirtual

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

    Redefined methods

    Reimplemented from TObj_ObjectIterator.

    ◆ Next()

    void TObj_SequenceIterator::Next ( )
    overridevirtual

    Move to the next Item.

    Reimplemented from TObj_ObjectIterator.

    ◆ Value()

    occ::handle< TObj_Object > TObj_SequenceIterator::Value ( ) const
    overridevirtual

    Returns the current item.

    Reimplemented from TObj_ObjectIterator.

    Field Documentation

    ◆ myIndex

    int TObj_SequenceIterator::myIndex
    protected

    current index of object in sequence

    Fields

    ◆ myObjects

    occ::handle<NCollection_HSequence<occ::handle<TObj_Object> > > TObj_SequenceIterator::myObjects
    protected

    sequence of objects

    ◆ myType

    occ::handle<Standard_Type> TObj_SequenceIterator::myType
    protected

    type of object


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