include/opencascade/CDM_ReferenceIterator.hxx

0001 // Created on: 1997-08-04
0002 // Created by: Jean-Louis Frenkel
0003 // Copyright (c) 1997-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 _CDM_ReferenceIterator_HeaderFile
0018 #define _CDM_ReferenceIterator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <CDM_ListIteratorOfListOfReferences.hxx>
0025 #include <Standard_Integer.hxx>
0026 class CDM_Document;
0027
0028 class CDM_ReferenceIterator
0029 {
0030 public:
0031   DEFINE_STANDARD_ALLOC
0032
0033   Standard_EXPORT CDM_ReferenceIterator(const Handle(CDM_Document)& aDocument);
0034
0035   Standard_EXPORT Standard_Boolean More() const;
0036
0037   Standard_EXPORT void Next();
0038
0039   Standard_EXPORT Handle(CDM_Document) Document() const;
0040
0041   Standard_EXPORT Standard_Integer ReferenceIdentifier() const;
0042
0043   //! returns the Document Version in the reference.
0044   Standard_EXPORT Standard_Integer DocumentVersion() const;
0045
0046 protected:
0047 private:
0048   CDM_ListIteratorOfListOfReferences myIterator;
0049 };
0050
0051 #endif // _CDM_ReferenceIterator_HeaderFile