0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / MAT / MAT_BasicElt.hxx
1 // Created on: 1993-04-30
2 // Created by: Yves FRICAUD
3 // Copyright (c) 1993-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 _MAT_BasicElt_HeaderFile
18 #define _MAT_BasicElt_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Address.hxx>
24 #include <Standard_Integer.hxx>
25 #include <Standard_Transient.hxx>
26 class MAT_Arc;
27
28
29 class MAT_BasicElt;
30 DEFINE_STANDARD_HANDLE(MAT_BasicElt, Standard_Transient)
31
32 //! A    BasicELt  is  associated   to  each  elementary
33 //! constituent of  the figure.
34 class MAT_BasicElt : public Standard_Transient
35 {
36
37 public:
38
39   
40   //! Constructor, <anInteger> is the <index> of <me>.
41   Standard_EXPORT MAT_BasicElt(const Standard_Integer anInteger);
42   
43   //! Return <startArcLeft> or <startArcRight> corresponding
44   //! to <aSide>.
45   Standard_EXPORT Handle(MAT_Arc) StartArc() const;
46   
47   //! Return <endArcLeft> or <endArcRight> corresponding
48   //! to <aSide>.
49   Standard_EXPORT Handle(MAT_Arc) EndArc() const;
50   
51   //! Return the <index> of <me> in Graph.TheBasicElts.
52   Standard_EXPORT Standard_Integer Index() const;
53   
54   //! Return the <GeomIndex> of <me>.
55   Standard_EXPORT Standard_Integer GeomIndex() const;
56   
57   Standard_EXPORT void SetStartArc (const Handle(MAT_Arc)& anArc);
58   
59   Standard_EXPORT void SetEndArc (const Handle(MAT_Arc)& anArc);
60   
61   Standard_EXPORT void SetIndex (const Standard_Integer anInteger);
62   
63   Standard_EXPORT void SetGeomIndex (const Standard_Integer anInteger);
64
65
66
67
68   DEFINE_STANDARD_RTTIEXT(MAT_BasicElt,Standard_Transient)
69
70 protected:
71
72
73
74
75 private:
76
77
78   Standard_Address startLeftArc;
79   Standard_Address endLeftArc;
80   Standard_Integer index;
81   Standard_Integer geomIndex;
82
83
84 };
85
86
87
88
89
90
91
92 #endif // _MAT_BasicElt_HeaderFile