include/opencascade/IFSelect_SelectRootComps.hxx

0001 // Created on: 1992-12-02
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 _IFSelect_SelectRootComps_HeaderFile
0018 #define _IFSelect_SelectRootComps_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_SelectExtract.hxx>
0024 #include <Standard_Integer.hxx>
0025 class Interface_EntityIterator;
0026 class Interface_Graph;
0027 class Standard_Transient;
0028 class Interface_InterfaceModel;
0029 class TCollection_AsciiString;
0030
0031 //! A SelectRootComps sorts the Entities which are part of Strong
0032 //! Components, local roots of a set of Entities : they can be
0033 //! Single Components (containing one Entity) or Cycles
0034 //! This class gives a more secure result than SelectRoots (which
0035 //! considers only Single Components) but is longer to work : it
0036 //! can be used when there can be or there are cycles in a Model
0037 //! For each cycle, one Entity is given arbitrarily
0038 //! Reject works as for SelectRoots : Strong Components defined in
0039 //! the input list which are not local roots are given
0040 class IFSelect_SelectRootComps : public IFSelect_SelectExtract
0041 {
0042
0043 public:
0044   //! Creates a SelectRootComps
0045   Standard_EXPORT IFSelect_SelectRootComps();
0046
0047   //! Returns the list of local root strong components, by one Entity per component.
0048   //! It is redefined for a purpose of efficiency : calling a Sort routine for each Entity would
0049   //! cost more resources than to work in once using a Map
0050   //! RootResult takes in account the Direct status
0051   Standard_EXPORT Interface_EntityIterator RootResult(const Interface_Graph& G) const override;
0052
0053   //! Returns always True, because RootResult has done work
0054   Standard_EXPORT bool Sort(const int                                    rank,
0055                             const occ::handle<Standard_Transient>&       ent,
0056                             const occ::handle<Interface_InterfaceModel>& model) const override;
0057
0058   //! Returns a text defining the criterium : "Local Root Components"
0059   Standard_EXPORT TCollection_AsciiString ExtractLabel() const override;
0060
0061   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectRootComps, IFSelect_SelectExtract)
0062
0063 protected:
0064   //! Returns True, RootResult assuring uniqueness
0065   Standard_EXPORT bool HasUniqueResult() const override;
0066 };
0067
0068 #endif // _IFSelect_SelectRootComps_HeaderFile