include/opencascade/IFSelect_SelectRoots.hxx

0001 // Created on: 1992-11-18
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_SelectRoots_HeaderFile
0018 #define _IFSelect_SelectRoots_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_SelectRoots;
0032 DEFINE_STANDARD_HANDLE(IFSelect_SelectRoots, IFSelect_SelectExtract)
0033
0034 //! A SelectRoots sorts the Entities which are local roots of a
0035 //! set of Entities (not shared by other Entities inside this set,
0036 //! even if they are shared by other Entities outside it)
0037 class IFSelect_SelectRoots : public IFSelect_SelectExtract
0038 {
0039
0040 public:
0041
0042   //! Creates a SelectRoots
0043   Standard_EXPORT IFSelect_SelectRoots();
0044
0045   //! Returns the list of local roots.
0046   //! It is redefined for a purpose of efficiency:
0047   //! calling a Sort routine for each Entity would cost more resources
0048   //! than to work in once using a Map RootResult takes in account the Direct status.
0049   Standard_EXPORT virtual Interface_EntityIterator RootResult (const Interface_Graph& G) const Standard_OVERRIDE;
0050
0051   //! Returns always True, because RootResult has done work
0052   Standard_EXPORT Standard_Boolean Sort (const Standard_Integer rank, const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
0053
0054   //! Returns a text defining the criterium : "Local Root Entities"
0055   Standard_EXPORT TCollection_AsciiString ExtractLabel() const Standard_OVERRIDE;
0056
0057   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectRoots,IFSelect_SelectExtract)
0058
0059 protected:
0060
0061   //! Returns True, because RootResult assures uniqueness
0062   Standard_EXPORT virtual Standard_Boolean HasUniqueResult() const Standard_OVERRIDE;
0063
0064 };
0065
0066 #endif // _IFSelect_SelectRoots_HeaderFile