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_ListIteratorOfListOfInterference.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <TopOpeBRepDS_Kind.hxx>
0027 #include <Standard_Integer.hxx>
0028 #include <TopOpeBRepDS_ListOfInterference.hxx>
0029 class TopOpeBRepDS_Interference;
0030
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
0045   DEFINE_STANDARD_ALLOC
0046
0047
0048   Standard_EXPORT TopOpeBRepDS_InterferenceIterator();
0049
0050   //! Creates an iterator on the Interference of list <L>.
0051   Standard_EXPORT TopOpeBRepDS_InterferenceIterator(const TopOpeBRepDS_ListOfInterference& L);
0052
0053   //! re-initialize  interference iteration  process  on
0054   //! the list of interference <L>.
0055   //! Conditions are not modified.
0056   Standard_EXPORT void Init (const TopOpeBRepDS_ListOfInterference& L);
0057
0058   //! define a condition on interference iteration process.
0059   //! Interference must match the Geometry Kind <ST>
0060   Standard_EXPORT void GeometryKind (const TopOpeBRepDS_Kind GK);
0061
0062   //! define a condition on interference iteration process.
0063   //! Interference must match the Geometry <G>
0064   Standard_EXPORT void Geometry (const Standard_Integer G);
0065
0066   //! define a condition on interference iteration process.
0067   //! Interference must match the Support Kind <ST>
0068   Standard_EXPORT void SupportKind (const TopOpeBRepDS_Kind ST);
0069
0070   //! define a condition on interference iteration process.
0071   //! Interference must match the Support <S>
0072   Standard_EXPORT void Support (const Standard_Integer S);
0073
0074   //! reach for an interference  matching the conditions
0075   //! (if  defined).
0076   Standard_EXPORT void Match();
0077
0078   //! Returns  True if the Interference <I>  matches the
0079   //! conditions (if defined).
0080   //! If no conditions defined, returns True.
0081   Standard_EXPORT virtual Standard_Boolean MatchInterference (const Handle(TopOpeBRepDS_Interference)& I) const;
0082
0083   //! Returns True if there is a current Interference in
0084   //! the iteration.
0085   Standard_EXPORT Standard_Boolean 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 Handle(TopOpeBRepDS_Interference)& Value() const;
0093
0094   Standard_EXPORT TopOpeBRepDS_ListIteratorOfListOfInterference& ChangeIterator();
0095
0096
0097
0098
0099 protected:
0100
0101
0102
0103
0104
0105 private:
0106
0107
0108
0109   TopOpeBRepDS_ListIteratorOfListOfInterference myIterator;
0110   Standard_Boolean myGKDef;
0111   TopOpeBRepDS_Kind myGK;
0112   Standard_Boolean myGDef;
0113   Standard_Integer myG;
0114   Standard_Boolean mySKDef;
0115   TopOpeBRepDS_Kind mySK;
0116   Standard_Boolean mySDef;
0117   Standard_Integer myS;
0118
0119
0120 };
0121
0122
0123
0124
0125
0126
0127
0128 #endif // _TopOpeBRepDS_InterferenceIterator_HeaderFile