include/opencascade/TopOpeBRepDS_InterferenceIterator.hxx

0001 // Created on: 1994-06-06
0002 // Created by: Jean Yves LEBEY
0003 // Copyright (c) 1994-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 _TopOpeBRepDS_InterferenceIterator_HeaderFile
0018 #define _TopOpeBRepDS_InterferenceIterator_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopOpeBRepDS_Interference.hxx>
0025
0026 #include <NCollection_List.hxx>
0027 #include <Standard_Boolean.hxx>
0028 #include <TopOpeBRepDS_Kind.hxx>
0029 #include <Standard_Integer.hxx>
0030 class TopOpeBRepDS_Interference;
0031
0032 //! Iterate on interferences of a list, matching
0033 //! conditions on interferences.
0034 //! Nota:
0035 //! inheritance of ListIteratorOfListOfInterference from
0036 //! TopOpeBRepDS has not been done because of the
0037 //! impossibility of naming the classical More, Next
0038 //! methods which are declared as static in
0039 //! TCollection_ListIteratorOfList ... . ListIteratorOfList
0040 //! has benn placed as a field of InterferenceIterator.
0041 class TopOpeBRepDS_InterferenceIterator
0042 {
0043 public:
0044   DEFINE_STANDARD_ALLOC
0045
0046   Standard_EXPORT TopOpeBRepDS_InterferenceIterator();
0047
0048   //! Creates an iterator on the Interference of list <L>.
0049   Standard_EXPORT TopOpeBRepDS_InterferenceIterator(
0050     const NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& L);
0051
0052   //! re-initialize interference iteration process on
0053   //! the list of interference <L>.
0054   //! Conditions are not modified.
0055   Standard_EXPORT void Init(const NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& L);
0056
0057   //! define a condition on interference iteration process.
0058   //! Interference must match the Geometry Kind <ST>
0059   Standard_EXPORT void GeometryKind(const TopOpeBRepDS_Kind GK);
0060
0061   //! define a condition on interference iteration process.
0062   //! Interference must match the Geometry <G>
0063   Standard_EXPORT void Geometry(const int G);
0064
0065   //! define a condition on interference iteration process.
0066   //! Interference must match the Support Kind <ST>
0067   Standard_EXPORT void SupportKind(const TopOpeBRepDS_Kind ST);
0068
0069   //! define a condition on interference iteration process.
0070   //! Interference must match the Support <S>
0071   Standard_EXPORT void Support(const int S);
0072
0073   //! reach for an interference matching the conditions
0074   //! (if defined).
0075   Standard_EXPORT void Match();
0076
0077   //! Returns True if the Interference <I> matches the
0078   //! conditions (if defined).
0079   //! If no conditions defined, returns True.
0080   Standard_EXPORT virtual bool MatchInterference(
0081     const occ::handle<TopOpeBRepDS_Interference>& I) const;
0082
0083   //! Returns True if there is a current Interference in
0084   //! the iteration.
0085   Standard_EXPORT bool More() const;
0086
0087   //! Move to the next Interference.
0088   Standard_EXPORT void Next();
0089
0090   //! Returns the current Interference, matching the
0091   //! conditions (if defined).
0092   Standard_EXPORT const occ::handle<TopOpeBRepDS_Interference>& Value() const;
0093
0094   Standard_EXPORT NCollection_List<occ::handle<TopOpeBRepDS_Interference>>::Iterator&
0095                   ChangeIterator();
0096
0097 private:
0098   NCollection_List<occ::handle<TopOpeBRepDS_Interference>>::Iterator myIterator;
0099   bool                                                               myGKDef;
0100   TopOpeBRepDS_Kind                                                  myGK;
0101   bool                                                               myGDef;
0102   int                                                                myG;
0103   bool                                                               mySKDef;
0104   TopOpeBRepDS_Kind                                                  mySK;
0105   bool                                                               mySDef;
0106   int                                                                myS;
0107 };
0108
0109 #endif // _TopOpeBRepDS_InterferenceIterator_HeaderFile