Open CASCADE Technology 7.8.2.dev
TNaming_Iterator Class Reference

A tool to visit the contents of a named shape attribute. Pairs of shapes in the attribute are iterated, one being the pre-modification or the old shape, and the other the post-modification or the new shape. This allows you to have a full access to all contents of an attribute. If, on the other hand, you are only interested in topological entities stored in the attribute, you can use the functions GetShape and CurrentShape in TNaming_Tool. More...

#include <TNaming_Iterator.hxx>

Public Member Functions

 TNaming_Iterator (const Handle< TNaming_NamedShape > &anAtt)
 Iterates on all the history records in <anAtt>.
 
 TNaming_Iterator (const TDF_Label &aLabel)
 Iterates on all the history records in the current transaction.
 
 TNaming_Iterator (const TDF_Label &aLabel, const Standard_Integer aTrans)
 Iterates on all the history records in the transaction <aTrans>
 
Standard_Boolean More () const
 Returns True if there is a current Item in the iteration.
 
void Next ()
 Moves the iteration to the next Item.
 
const TopoDS_ShapeOldShape () const
 Returns the old shape in this iterator object. This shape can be a null one.
 
const TopoDS_ShapeNewShape () const
 Returns the new shape in this iterator object.
 
Standard_Boolean IsModification () const
 Returns true if the new shape is a modification (split, fuse,etc...) of the old shape.
 
TNaming_Evolution Evolution () const
 

Detailed Description

A tool to visit the contents of a named shape attribute. Pairs of shapes in the attribute are iterated, one being the pre-modification or the old shape, and the other the post-modification or the new shape. This allows you to have a full access to all contents of an attribute. If, on the other hand, you are only interested in topological entities stored in the attribute, you can use the functions GetShape and CurrentShape in TNaming_Tool.

Constructor & Destructor Documentation

◆ TNaming_Iterator() [1/3]

TNaming_Iterator::TNaming_Iterator ( const Handle< TNaming_NamedShape > & anAtt)

Iterates on all the history records in <anAtt>.

◆ TNaming_Iterator() [2/3]

TNaming_Iterator::TNaming_Iterator ( const TDF_Label & aLabel)

Iterates on all the history records in the current transaction.

◆ TNaming_Iterator() [3/3]

TNaming_Iterator::TNaming_Iterator ( const TDF_Label & aLabel,
const Standard_Integer aTrans )

Iterates on all the history records in the transaction <aTrans>

Member Function Documentation

◆ Evolution()

TNaming_Evolution TNaming_Iterator::Evolution ( ) const

◆ IsModification()

Standard_Boolean TNaming_Iterator::IsModification ( ) const

Returns true if the new shape is a modification (split, fuse,etc...) of the old shape.

◆ More()

Standard_Boolean TNaming_Iterator::More ( ) const

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

◆ NewShape()

const TopoDS_Shape & TNaming_Iterator::NewShape ( ) const

Returns the new shape in this iterator object.

◆ Next()

void TNaming_Iterator::Next ( )

Moves the iteration to the next Item.

◆ OldShape()

const TopoDS_Shape & TNaming_Iterator::OldShape ( ) const

Returns the old shape in this iterator object. This shape can be a null one.


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