include/opencascade/Transfer_IteratorOfProcessForTransient.hxx

0001 // Created on: 1992-02-03
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-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 _Transfer_IteratorOfProcessForTransient_HeaderFile
0018 #define _Transfer_IteratorOfProcessForTransient_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Transient.hxx>
0025 #include <NCollection_Sequence.hxx>
0026 #include <NCollection_HSequence.hxx>
0027 #include <Transfer_TransferIterator.hxx>
0028 #include <NCollection_IndexedDataMap.hxx>
0029 #include <Transfer_Binder.hxx>
0030
0031 class Standard_NoSuchObject;
0032 class Standard_Transient;
0033 class Transfer_ProcessForTransient;
0034 class Transfer_ActorOfProcessForTransient;
0035 class Transfer_Binder;
0036
0037 class Transfer_IteratorOfProcessForTransient : public Transfer_TransferIterator
0038 {
0039 public:
0040   DEFINE_STANDARD_ALLOC
0041
0042   //! Creates an empty Iterator
0043   //! if withstarts is True, each Binder to be iterated will
0044   //! be associated to its corresponding Starting Object
0045   Standard_EXPORT Transfer_IteratorOfProcessForTransient(const bool withstarts);
0046
0047   //! Adds a Binder to the iteration list (construction)
0048   //! with no corresponding Starting Object
0049   //! (note that Result is brought by Binder)
0050   Standard_EXPORT void Add(const occ::handle<Transfer_Binder>& binder);
0051
0052   //! Adds a Binder to the iteration list, associated with
0053   //! its corresponding Starting Object "start"
0054   //! Starting Object is ignored if not required at
0055   //! Creation time
0056   Standard_EXPORT void Add(const occ::handle<Transfer_Binder>&    binder,
0057                            const occ::handle<Standard_Transient>& start);
0058
0059   //! After having added all items, keeps or rejects items
0060   //! which are attached to starting data given by <only>
0061   //! <keep> = True (D) : keeps. <keep> = False : rejects
0062   //! Does nothing if <withstarts> was False
0063   Standard_EXPORT void Filter(
0064     const occ::handle<NCollection_HSequence<occ::handle<Standard_Transient>>>& list,
0065     const bool                                                                 keep = true);
0066
0067   //! Returns True if Starting Object is available
0068   //! (defined at Creation Time)
0069   Standard_EXPORT bool HasStarting() const;
0070
0071   //! Returns corresponding Starting Object
0072   Standard_EXPORT const occ::handle<Standard_Transient>& Starting() const;
0073
0074 private:
0075   occ::handle<NCollection_HSequence<occ::handle<Standard_Transient>>> thestarts;
0076 };
0077
0078 #endif // _Transfer_IteratorOfProcessForTransient_HeaderFile