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