include/opencascade/PCDM_ReferenceIterator.hxx

0001 // Created on: 1997-12-01
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 _PCDM_ReferenceIterator_HeaderFile
0018 #define _PCDM_ReferenceIterator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <PCDM_Reference.hxx>
0024 #include <NCollection_Sequence.hxx>
0025 #include <TCollection_ExtendedString.hxx>
0026 #include <NCollection_DataMap.hxx>
0027
0028 class Message_Messenger;
0029 class CDM_Document;
0030 class CDM_MetaData;
0031 class CDM_Application;
0032
0033 class PCDM_ReferenceIterator : public Standard_Transient
0034 {
0035
0036 public:
0037   //! Warning! The constructor does not initialization.
0038   Standard_EXPORT PCDM_ReferenceIterator(const occ::handle<Message_Messenger>& theMessageDriver);
0039
0040   Standard_EXPORT void LoadReferences(const occ::handle<CDM_Document>&    aDocument,
0041                                       const occ::handle<CDM_MetaData>&    aMetaData,
0042                                       const occ::handle<CDM_Application>& anApplication,
0043                                       const bool                          UseStorageConfiguration);
0044
0045   Standard_EXPORT virtual void Init(const occ::handle<CDM_MetaData>& aMetaData);
0046
0047   DEFINE_STANDARD_RTTIEXT(PCDM_ReferenceIterator, Standard_Transient)
0048
0049 private:
0050   Standard_EXPORT virtual bool More() const;
0051
0052   Standard_EXPORT virtual void Next();
0053
0054   Standard_EXPORT virtual occ::handle<CDM_MetaData> MetaData(
0055     NCollection_DataMap<TCollection_ExtendedString, occ::handle<CDM_MetaData>>& theLookUpTable,
0056     const bool UseStorageConfiguration) const;
0057
0058   Standard_EXPORT virtual int ReferenceIdentifier() const;
0059
0060   //! returns the version of the document in the reference
0061   Standard_EXPORT virtual int DocumentVersion() const;
0062
0063 private:
0064   NCollection_Sequence<PCDM_Reference> myReferences;
0065   int                                  myIterator;
0066   occ::handle<Message_Messenger>       myMessageDriver;
0067 };
0068
0069 #endif // _PCDM_ReferenceIterator_HeaderFile