src/CDF/CDF_StoreList.cdl

   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 private class StoreList from CDF inherits Transient from Standard
  18
  19 uses
  20     Document from CDM,
  21     StackOfDocument from CDM,
  22     MapOfDocument from CDM,
  23     MapIteratorOfMapOfDocument from CDM,
  24     ListIteratorOfStackOfDocument from CDM,
  25     MetaData from CDM,
  26     ExtendedString from TCollection,
  27     StoreStatus from PCDM
  28
  29 raises NoSuchObject from Standard
  30 is
  31
  32     Create(aDocument: Document from CDM)
  33     returns mutable StoreList from CDF;
  34
  35     IsConsistent(me) returns Boolean from Standard;
  36
  37
  38     Store(me: mutable; aMetaData: out MetaData from CDM;
  39                        aStatusAssociatedText: out ExtendedString from TCollection)
  40     returns StoreStatus from PCDM
  41     ---Purpose: stores each object of the storelist in the reverse
  42     --          order of which they had been added.
  43     raises NoSuchObject from Standard;
  44     ---Warning: if the active dbunit cannot be found
  45
  46
  47      ---Category: Private methods.
  48
  49
  50     Add(me: mutable; aDocument: Document from CDM)
  51     is private;
  52
  53  ---Category: iteration methods
  54     Init(me: mutable);
  55     More(me) returns Boolean from Standard;
  56     Next(me: mutable);
  57     Value(me) returns Document from CDM;
  58
  59
  60 fields
  61
  62     myItems: MapOfDocument from CDM;
  63     myStack: StackOfDocument from CDM;
  64     myIterator: MapIteratorOfMapOfDocument from CDM;
  65     myMainDocument: Document from CDM;
  66 end StoreList from CDF;