0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IFGraph / IFGraph_Articulations.hxx
1 // Created on: 1992-09-23
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_Articulations_HeaderFile
18 #define _IFGraph_Articulations_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Interface_Graph.hxx>
25 #include <Standard_Integer.hxx>
26 #include <TColStd_HSequenceOfInteger.hxx>
27 #include <Interface_GraphContent.hxx>
28 #include <Standard_Boolean.hxx>
29 class Interface_Graph;
30 class Standard_Transient;
31 class Interface_EntityIterator;
32
33 //! this class gives entities which are Articulation points
34 //! in a whole Model or in a sub-part
35 //! An Articulation Point divides the graph in two (or more)
36 //! disconnected sub-graphs
37 //! Identifying Articulation Points allows improving
38 //! efficiency of splitting a set of Entities into sub-sets
39 class IFGraph_Articulations  : public Interface_GraphContent
40 {
41 public:
42
43   DEFINE_STANDARD_ALLOC
44
45   //! creates Articulations to evaluate a Graph
46   //! whole True : works on the whole Model
47   //! whole False : remains empty, ready to work on a sub-part
48   Standard_EXPORT IFGraph_Articulations(const Interface_Graph& agraph, const Standard_Boolean whole);
49   
50   //! adds an entity and its shared ones to the list
51   Standard_EXPORT void GetFromEntity (const Handle(Standard_Transient)& ent);
52   
53   //! adds a list of entities (as an iterator)
54   Standard_EXPORT void GetFromIter (const Interface_EntityIterator& iter);
55   
56   //! Allows to restart on a new data set
57   Standard_EXPORT void ResetData();
58   
59   //! Evaluates the list of Articulation points
60   Standard_EXPORT virtual void Evaluate() Standard_OVERRIDE;
61
62 private:
63
64   //! basic routine of computation
65   //! (see book Sedgewick "Algorithms", p 392)
66   Standard_EXPORT Standard_Integer Visit (const Standard_Integer num);
67
68 private:
69
70   Interface_Graph thegraph;
71   Standard_Integer thenow;
72   Handle(TColStd_HSequenceOfInteger) thelist;
73
74 };
75
76 #endif // _IFGraph_Articulations_HeaderFile