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