src/CDF/CDF_StoreList.hxx

   1 // Created on: 1995-03-22
   2 // Created by: Jean-Louis  Frenkel
   3 // Copyright (c) 1995-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _CDF_StoreList_HeaderFile
  18 #define _CDF_StoreList_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <CDM_MapOfDocument.hxx>
  24 #include <CDM_ListOfDocument.hxx>
  25 #include <CDM_MapIteratorOfMapOfDocument.hxx>
  26 #include <Standard_Transient.hxx>
  27 #include <Standard_Boolean.hxx>
  28 #include <PCDM_StoreStatus.hxx>
  29 #include <Message_ProgressIndicator.hxx>
  30
  31 class CDM_Document;
  32 class Standard_NoSuchObject;
  33 class CDM_MetaData;
  34 class TCollection_ExtendedString;
  35
  36
  37 class CDF_StoreList;
  38 DEFINE_STANDARD_HANDLE(CDF_StoreList, Standard_Transient)
  39
  40
  41 class CDF_StoreList : public Standard_Transient
  42 {
  43
  44 public:
  45
  46
  47   Standard_EXPORT CDF_StoreList(const Handle(CDM_Document)& aDocument);
  48
  49   Standard_EXPORT Standard_Boolean IsConsistent() const;
  50
  51   //! stores each object of the storelist in the reverse
  52   //! order of which they had been added.
  53   Standard_EXPORT PCDM_StoreStatus Store (Handle(CDM_MetaData)& aMetaData,
  54                                           TCollection_ExtendedString& aStatusAssociatedText,
  55                                           const Message_ProgressRange& theRange = Message_ProgressRange());
  56
  57   Standard_EXPORT void Init();
  58
  59   Standard_EXPORT Standard_Boolean More() const;
  60
  61   Standard_EXPORT void Next();
  62
  63   Standard_EXPORT Handle(CDM_Document) Value() const;
  64
  65
  66
  67
  68   DEFINE_STANDARD_RTTIEXT(CDF_StoreList,Standard_Transient)
  69
  70 protected:
  71
  72
  73
  74
  75 private:
  76
  77
  78   Standard_EXPORT void Add (const Handle(CDM_Document)& aDocument);
  79
  80   CDM_MapOfDocument myItems;
  81   CDM_ListOfDocument myStack;
  82   CDM_MapIteratorOfMapOfDocument myIterator;
  83   Handle(CDM_Document) myMainDocument;
  84
  85
  86 };
  87
  88
  89
  90
  91
  92
  93
  94 #endif // _CDF_StoreList_HeaderFile