include/opencascade/TNaming_Iterator.hxx

0001 // Created on: 1996-12-16
0002 // Created by: Remi Lequette
0003 // Copyright (c) 1996-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TNaming_Iterator_HeaderFile
0018 #define _TNaming_Iterator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TNaming_PtrNode.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <TNaming_Evolution.hxx>
0027 class Standard_NoMoreObject;
0028 class Standard_NoSuchObject;
0029 class TNaming_NewShapeIterator;
0030 class TNaming_OldShapeIterator;
0031 class TNaming_NamedShape;
0032 class TDF_Label;
0033 class TopoDS_Shape;
0034
0035 //! A tool to visit the contents of a named shape attribute.
0036 //! Pairs of shapes in the attribute are iterated, one
0037 //! being the pre-modification or the old shape, and
0038 //! the other the post-modification or the new shape.
0039 //! This allows you to have a full access to all
0040 //! contents of an attribute. If, on the other hand, you
0041 //! are only interested in topological entities stored
0042 //! in the attribute, you can use the functions
0043 //! GetShape and CurrentShape in TNaming_Tool.
0044 class TNaming_Iterator
0045 {
0046 public:
0047   DEFINE_STANDARD_ALLOC
0048
0049   //! Iterates on all the history records in
0050   //! <anAtt>.
0051   Standard_EXPORT TNaming_Iterator(const occ::handle<TNaming_NamedShape>& anAtt);
0052
0053   //! Iterates on all the history records in
0054   //! the current transaction
0055   Standard_EXPORT TNaming_Iterator(const TDF_Label& aLabel);
0056
0057   //! Iterates on all the history records in
0058   //! the transaction <aTrans>
0059   Standard_EXPORT TNaming_Iterator(const TDF_Label& aLabel, const int aTrans);
0060
0061   //! Returns True if there is a current Item in
0062   //! the iteration.
0063   bool More() const;
0064
0065   //! Moves the iteration to the next Item
0066   Standard_EXPORT void Next();
0067
0068   //! Returns the old shape in this iterator object.
0069   //! This shape can be a null one.
0070   Standard_EXPORT const TopoDS_Shape& OldShape() const;
0071
0072   //! Returns the new shape in this iterator object.
0073   Standard_EXPORT const TopoDS_Shape& NewShape() const;
0074
0075   //! Returns true if the new shape is a modification
0076   //! (split, fuse, etc...) of the old shape.
0077   Standard_EXPORT bool IsModification() const;
0078
0079   Standard_EXPORT TNaming_Evolution Evolution() const;
0080
0081   friend class TNaming_NewShapeIterator;
0082   friend class TNaming_OldShapeIterator;
0083
0084 private:
0085   TNaming_PtrNode myNode;
0086   int             myTrans;
0087 };
0088
0089 #include <TNaming_Iterator.lxx>
0090
0091 #endif // _TNaming_Iterator_HeaderFile