src/Transfer/Transfer_IteratorOfProcessForTransient.hxx

   1 // Created on: 1992-02-03
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1992-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 _Transfer_IteratorOfProcessForTransient_HeaderFile
  18 #define _Transfer_IteratorOfProcessForTransient_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TColStd_HSequenceOfTransient.hxx>
  25 #include <Transfer_TransferIterator.hxx>
  26 #include <Transfer_TransferMapOfProcessForTransient.hxx>
  27
  28 class Standard_NoSuchObject;
  29 class Standard_Transient;
  30 class Transfer_ProcessForTransient;
  31 class Transfer_ActorOfProcessForTransient;
  32 class Transfer_Binder;
  33
  34 class Transfer_IteratorOfProcessForTransient  : public Transfer_TransferIterator
  35 {
  36 public:
  37
  38   DEFINE_STANDARD_ALLOC
  39
  40
  41   //! Creates an empty Iterator
  42   //! if withstarts is True, each Binder to be iterated will
  43   //! be associated to its corresponding Starting Object
  44   Standard_EXPORT Transfer_IteratorOfProcessForTransient(const Standard_Boolean withstarts);
  45
  46   //! Adds a Binder to the iteration list (construction)
  47   //! with no corresponding Starting Object
  48   //! (note that Result is brought by Binder)
  49   Standard_EXPORT void Add (const Handle(Transfer_Binder)& binder);
  50
  51   //! Adds a Binder to the iteration list, associated with
  52   //! its corresponding Starting Object "start"
  53   //! Starting Object is ignored if not required at
  54   //! Creation time
  55   Standard_EXPORT void Add (const Handle(Transfer_Binder)& binder, const Handle(Standard_Transient)& start);
  56
  57   //! After having added all items, keeps or rejects items
  58   //! which are attached to starting data given by <only>
  59   //! <keep> = True (D) : keeps. <keep> = False : rejects
  60   //! Does nothing if <withstarts> was False
  61   Standard_EXPORT void Filter (const Handle(TColStd_HSequenceOfTransient)& list, const Standard_Boolean keep = Standard_True);
  62
  63   //! Returns True if Starting Object is available
  64   //! (defined at Creation Time)
  65   Standard_EXPORT Standard_Boolean HasStarting() const;
  66
  67   //! Returns corresponding Starting Object
  68   Standard_EXPORT const Handle(Standard_Transient)& Starting() const;
  69
  70
  71
  72
  73 protected:
  74
  75
  76
  77
  78
  79 private:
  80
  81
  82
  83   Handle(TColStd_HSequenceOfTransient) thestarts;
  84
  85
  86 };
  87
  88
  89
  90
  91
  92
  93
  94 #endif // _Transfer_IteratorOfProcessForTransient_HeaderFile