include/opencascade/IGESSelect_SelectBypassSubfigure.hxx

0001 // Created on: 1998-01-13
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1998-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 _IGESSelect_SelectBypassSubfigure_HeaderFile
0018 #define _IGESSelect_SelectBypassSubfigure_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_SelectExplore.hxx>
0024 #include <Standard_Integer.hxx>
0025 class Standard_Transient;
0026 class Interface_Graph;
0027 class Interface_EntityIterator;
0028 class TCollection_AsciiString;
0029
0030 //! Selects a list built as follows :
0031 //! Subfigures correspond to
0032 //! * Definition (basic : type 308, or Network : type 320)
0033 //! * Instance (Singular : type 408, or Network : 420, or
0034 //! patterns : 412,414)
0035 //!
0036 //! Entities which are not Subfigure are taken as such
0037 //! For Subfigures Instances, their definition is taken, then
0038 //! explored itself
0039 //! For Subfigures Definitions, the list of "Associated Entities"
0040 //! is explored
0041 //! Hence, level 0 (D) recursively explores a Subfigure if some of
0042 //! its Elements are Subfigures. level 1 explores just at first
0043 //! level (i.e. for an instance, returns its definition)
0044 class IGESSelect_SelectBypassSubfigure : public IFSelect_SelectExplore
0045 {
0046
0047 public:
0048   //! Creates a SelectBypassSubfigure, by default all level
0049   //! (level = 1 explores at first level)
0050   Standard_EXPORT IGESSelect_SelectBypassSubfigure(const int level = 0);
0051
0052   //! Explores an entity : for a Subfigure, gives its elements
0053   //! Else, takes the entity itself
0054   Standard_EXPORT bool Explore(const int                              level,
0055                                const occ::handle<Standard_Transient>& ent,
0056                                const Interface_Graph&                 G,
0057                                Interface_EntityIterator&              explored) const override;
0058
0059   //! Returns a text defining the criterium : "Content of Subfigure"
0060   Standard_EXPORT TCollection_AsciiString ExploreLabel() const override;
0061
0062   DEFINE_STANDARD_RTTIEXT(IGESSelect_SelectBypassSubfigure, IFSelect_SelectExplore)
0063 };
0064
0065 #endif // _IGESSelect_SelectBypassSubfigure_HeaderFile