include/opencascade/CDF_StoreList.hxx

0001 // Created on: 1995-03-22
0002 // Created by: Jean-Louis  Frenkel
0003 // Copyright (c) 1995-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 _CDF_StoreList_HeaderFile
0018 #define _CDF_StoreList_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <CDM_ListOfDocument.hxx>
0024 #include <CDM_MapIteratorOfMapOfDocument.hxx>
0025 #include <Standard_Transient.hxx>
0026 #include <PCDM_StoreStatus.hxx>
0027
0028 class CDM_Document;
0029 class CDM_MetaData;
0030 class TCollection_ExtendedString;
0031
0032 class CDF_StoreList;
0033 DEFINE_STANDARD_HANDLE(CDF_StoreList, Standard_Transient)
0034
0035 class CDF_StoreList : public Standard_Transient
0036 {
0037
0038 public:
0039   Standard_EXPORT CDF_StoreList(const Handle(CDM_Document)& aDocument);
0040
0041   Standard_EXPORT Standard_Boolean IsConsistent() const;
0042
0043   //! stores each object of the storelist in the reverse
0044   //! order of which they had been added.
0045   Standard_EXPORT PCDM_StoreStatus
0046     Store(Handle(CDM_MetaData)&        aMetaData,
0047           TCollection_ExtendedString&  aStatusAssociatedText,
0048           const Message_ProgressRange& theRange = Message_ProgressRange());
0049
0050   Standard_EXPORT void Init();
0051
0052   Standard_EXPORT Standard_Boolean More() const;
0053
0054   Standard_EXPORT void Next();
0055
0056   Standard_EXPORT Handle(CDM_Document) Value() const;
0057
0058   DEFINE_STANDARD_RTTIEXT(CDF_StoreList, Standard_Transient)
0059
0060 protected:
0061 private:
0062   Standard_EXPORT void Add(const Handle(CDM_Document)& aDocument);
0063
0064   CDM_MapOfDocument              myItems;
0065   CDM_ListOfDocument             myStack;
0066   CDM_MapIteratorOfMapOfDocument myIterator;
0067   Handle(CDM_Document)           myMainDocument;
0068 };
0069
0070 #endif // _CDF_StoreList_HeaderFile