0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IFSelect / IFSelect_SelectRoots.hxx
1 // Created on: 1992-11-18
2 // Created by: Christian CAILLET
3 // Copyright (c) 1992-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 _IFSelect_SelectRoots_HeaderFile
18 #define _IFSelect_SelectRoots_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <IFSelect_SelectExtract.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Integer.hxx>
26 class Interface_EntityIterator;
27 class Interface_Graph;
28 class Standard_Transient;
29 class Interface_InterfaceModel;
30 class TCollection_AsciiString;
31
32 class IFSelect_SelectRoots;
33 DEFINE_STANDARD_HANDLE(IFSelect_SelectRoots, IFSelect_SelectExtract)
34
35 //! A SelectRoots sorts the Entities which are local roots of a
36 //! set of Entities (not shared by other Entities inside this set,
37 //! even if they are shared by other Entities outside it)
38 class IFSelect_SelectRoots : public IFSelect_SelectExtract
39 {
40
41 public:
42
43   //! Creates a SelectRoots
44   Standard_EXPORT IFSelect_SelectRoots();
45
46   //! Returns the list of local roots.
47   //! It is redefined for a purpose of efficiency:
48   //! calling a Sort routine for each Entity would cost more resources
49   //! than to work in once using a Map RootResult takes in account the Direct status.
50   Standard_EXPORT virtual Interface_EntityIterator RootResult (const Interface_Graph& G) const Standard_OVERRIDE;
51
52   //! Returns always True, because RootResult has done work
53   Standard_EXPORT Standard_Boolean Sort (const Standard_Integer rank, const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
54   
55   //! Returns a text defining the criterium : "Local Root Entities"
56   Standard_EXPORT TCollection_AsciiString ExtractLabel() const Standard_OVERRIDE;
57
58   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectRoots,IFSelect_SelectExtract)
59
60 protected:
61
62   //! Returns True, because RootResult assures uniqueness
63   Standard_EXPORT virtual Standard_Boolean HasUniqueResult() const Standard_OVERRIDE;
64
65 };
66
67 #endif // _IFSelect_SelectRoots_HeaderFile