0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BOPDS / BOPDS_Pave.hxx
1 // Created by: Peter KURNEV
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _BOPDS_Pave_HeaderFile
16 #define _BOPDS_Pave_HeaderFile
17
18 #include <Standard.hxx>
19 #include <Standard_DefineAlloc.hxx>
20 #include <Standard_Handle.hxx>
21
22 #include <Standard_Integer.hxx>
23 #include <Standard_Real.hxx>
24 #include <Standard_Boolean.hxx>
25
26
27
28 //! The class BOPDS_Pave is to store
29 //! information about vertex on an edge
30 class BOPDS_Pave 
31 {
32 public:
33
34   DEFINE_STANDARD_ALLOC
35
36   
37
38   //! Empty contructor
39     BOPDS_Pave();
40 Standard_EXPORT virtual ~BOPDS_Pave();
41   
42
43   //! Modifier
44   //! Sets the index of vertex <theIndex>
45     void SetIndex (const Standard_Integer theIndex);
46   
47
48   //! Selector
49   //! Returns the index of vertex
50     Standard_Integer Index() const;
51   
52
53   //! Modifier
54   //! Sets the parameter of vertex <theParameter>
55     void SetParameter (const Standard_Real theParameter);
56   
57
58   //! Selector
59   //! Returns the parameter of vertex
60     Standard_Real Parameter() const;
61   
62
63   //! Selector
64   //! Returns the index of vertex <theIndex>
65   //! Returns the parameter of vertex <theParameter>
66     void Contents (Standard_Integer& theIndex, Standard_Real& theParameter) const;
67   
68
69   //! Query
70   //! Returns true if thr parameter od this is less
71   //! than the parameter of  <theOther>
72     Standard_Boolean IsLess (const BOPDS_Pave& theOther) const;
73   Standard_Boolean operator < (const BOPDS_Pave& theOther) const
74 {
75   return IsLess(theOther);
76 }
77   
78
79   //! Query
80   //! Returns true if thr parameter od this is equal
81   //! to the parameter of  <theOther>
82     Standard_Boolean IsEqual (const BOPDS_Pave& theOther) const;
83   Standard_Boolean operator == (const BOPDS_Pave& theOther) const
84 {
85   return IsEqual(theOther);
86 }
87   
88   Standard_EXPORT void Dump() const;
89
90
91
92
93 protected:
94
95
96
97   Standard_Integer myIndex;
98   Standard_Real myParameter;
99
100
101 private:
102
103
104
105
106
107 };
108
109
110 #include <BOPDS_Pave.lxx>
111
112
113
114
115
116 #endif // _BOPDS_Pave_HeaderFile