src/IGESSelect/IGESSelect_SelectBypassSubfigure.hxx

   1 // Created on: 1998-01-13
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1998-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESSelect_SelectBypassSubfigure_HeaderFile
  18 #define _IGESSelect_SelectBypassSubfigure_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <IFSelect_SelectExplore.hxx>
  24 #include <Standard_Integer.hxx>
  25 #include <Standard_Boolean.hxx>
  26 class Interface_InterfaceError;
  27 class Standard_Transient;
  28 class Interface_Graph;
  29 class Interface_EntityIterator;
  30 class TCollection_AsciiString;
  31
  32
  33 class IGESSelect_SelectBypassSubfigure;
  34 DEFINE_STANDARD_HANDLE(IGESSelect_SelectBypassSubfigure, IFSelect_SelectExplore)
  35
  36 //! Selects a list built as follows :
  37 //! Subfigures correspond to
  38 //! * Definition (basic : type 308, or Network : type 320)
  39 //! * Instance (Singular : type 408, or Network : 420, or
  40 //! patterns : 412,414)
  41 //!
  42 //! Entities which are not Subfigure are taken as such
  43 //! For Subfigures Instances, their definition is taken, then
  44 //! explored itself
  45 //! For Subfigures Definitions, the list of "Associated Entities"
  46 //! is explored
  47 //! Hence, level 0 (D) recursively explores a Subfigure if some of
  48 //! its Elements are Subfigures. level 1 explores just at first
  49 //! level (i.e. for an instance, returns its definition)
  50 class IGESSelect_SelectBypassSubfigure : public IFSelect_SelectExplore
  51 {
  52
  53 public:
  54
  55
  56   //! Creates a SelectBypassSubfigure, by default all level
  57   //! (level = 1 explores at first level)
  58   Standard_EXPORT IGESSelect_SelectBypassSubfigure(const Standard_Integer level = 0);
  59
  60   //! Explores an entity : for a Subfigure, gives its elements
  61   //! Else, takes the entity itself
  62   Standard_EXPORT Standard_Boolean Explore (const Standard_Integer level, const Handle(Standard_Transient)& ent, const Interface_Graph& G, Interface_EntityIterator& explored) const Standard_OVERRIDE;
  63
  64   //! Returns a text defining the criterium : "Content of Subfigure"
  65   Standard_EXPORT TCollection_AsciiString ExploreLabel() const Standard_OVERRIDE;
  66
  67
  68
  69
  70   DEFINE_STANDARD_RTTIEXT(IGESSelect_SelectBypassSubfigure,IFSelect_SelectExplore)
  71
  72 protected:
  73
  74
  75
  76
  77 private:
  78
  79
  80
  81
  82 };
  83
  84
  85
  86
  87
  88
  89
  90 #endif // _IGESSelect_SelectBypassSubfigure_HeaderFile