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