0031939: Coding - correction of spelling errors in comments
[occt.git] / src / IFGraph / IFGraph_AllConnected.hxx
1 // Created on: 1992-10-02
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 _IFGraph_AllConnected_HeaderFile
18 #define _IFGraph_AllConnected_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Interface_Graph.hxx>
25 #include <Interface_GraphContent.hxx>
26 class Interface_Graph;
27 class Standard_Transient;
28
29
30 //! this class gives content of the CONNECTED COMPONENT(S)
31 //! which include specific Entity(ies)
32 class IFGraph_AllConnected  : public Interface_GraphContent
33 {
34 public:
35
36   DEFINE_STANDARD_ALLOC
37
38   
39   //! creates an AllConnected from a graph, empty ready to be filled
40   Standard_EXPORT IFGraph_AllConnected(const Interface_Graph& agraph);
41   
42   //! creates an AllConnected which memorizes Entities Connected to
43   //! a given one, at any level : that is, itself, all Entities
44   //! Shared by it and Sharing it, and so on.
45   //! In other terms, this is the content of the CONNECTED COMPONENT
46   //! which include a specific Entity
47   Standard_EXPORT IFGraph_AllConnected(const Interface_Graph& agraph, const Handle(Standard_Transient)& ent);
48   
49   //! adds an entity and its Connected ones to the list (allows to
50   //! cumulate all Entities Connected by some ones)
51   //! Note that if "ent" is in the already computed list,, no entity
52   //! will be added, but if "ent" is not already in the list, a new
53   //! Connected Component will be cumulated
54   Standard_EXPORT void GetFromEntity (const Handle(Standard_Transient)& ent);
55   
56   //! Allows to restart on a new data set
57   Standard_EXPORT void ResetData();
58   
59   //! does the specific evaluation (Connected entities atall levels)
60   Standard_EXPORT virtual void Evaluate() Standard_OVERRIDE;
61
62
63
64
65 protected:
66
67
68
69
70
71 private:
72
73
74
75   Interface_Graph thegraph;
76
77
78 };
79
80
81
82
83
84
85
86 #endif // _IFGraph_AllConnected_HeaderFile