0026619: Tolerances of operands are modified using bop
[occt.git] / src / BOPDS / BOPDS_CommonBlock.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_CommonBlock_HeaderFile
16 #define _BOPDS_CommonBlock_HeaderFile
17
18 #include <Standard.hxx>
19 #include <Standard_Type.hxx>
20
21 #include <BOPDS_ListOfPaveBlock.hxx>
22 #include <BOPCol_ListOfInteger.hxx>
23 #include <MMgt_TShared.hxx>
24 #include <BOPCol_BaseAllocator.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_Boolean.hxx>
27 class BOPDS_PaveBlock;
28
29
30 class BOPDS_CommonBlock;
31 DEFINE_STANDARD_HANDLE(BOPDS_CommonBlock, MMgt_TShared)
32
33
34 //! The class BOPDS_CommonBlock is to store
35 //! the information about pave blocks that have
36 //! geometry coincidence (in  terms of a tolerance)  with
37 //! a) other pave block(s)
38 //! b) face(s)
39 class BOPDS_CommonBlock : public MMgt_TShared
40 {
41
42 public:
43
44   
45
46   //! Empty contructor
47   Standard_EXPORT BOPDS_CommonBlock();
48   
49
50   //! Contructor
51   //! <theAllocator> - the allocator to manage the memory
52   Standard_EXPORT BOPDS_CommonBlock(const BOPCol_BaseAllocator& theAllocator);
53   
54
55   //! Modifier
56   //! Adds the pave block <aPB> to the list of pave blocks
57   //! of the common block
58   Standard_EXPORT void AddPaveBlock (const Handle(BOPDS_PaveBlock)& aPB);
59   
60
61   //! Modifier
62   //! Adds the list of pave blocks <aLPB>
63   //! to the list of pave blocks
64   //! of the common block
65   Standard_EXPORT void AddPaveBlocks (const BOPDS_ListOfPaveBlock& aLPB);
66   
67
68   //! Modifier
69   //! Adds the index of the face <aF>
70   //! to the list of indices of faces
71   //! of the common block
72   Standard_EXPORT void AddFace (const Standard_Integer aF);
73   
74
75   //! Modifier
76   //! Sets the list of indices of faces <aLF>
77   //! of the common block
78   Standard_EXPORT void SetFaces (const BOPCol_ListOfInteger& aLF);
79
80   //! Modifier
81   //! Appends the list of indices of faces <aLF>
82   //! to the list of indices of faces
83   //! of the common block (the input list is emptied)
84   Standard_EXPORT void AppendFaces(BOPCol_ListOfInteger& aLF);
85
86
87   //! Selector
88   //! Returns the list of pave blocks
89   //! of the common block
90   Standard_EXPORT const BOPDS_ListOfPaveBlock& PaveBlocks() const;
91   
92
93   //! Selector
94   //! Returns the list of indices of faces
95   //! of the common block
96   Standard_EXPORT const BOPCol_ListOfInteger& Faces() const;
97   
98
99   //! Selector
100   //! Returns the first pave block
101   //! of the common block
102   Standard_EXPORT const Handle(BOPDS_PaveBlock)& PaveBlock1() const;
103   
104
105   //! Selector
106   //! Returns the pave block that belongs
107   //! to the edge with index <theIx>
108   Standard_EXPORT Handle(BOPDS_PaveBlock)& PaveBlockOnEdge (const Standard_Integer theIndex);
109   
110
111   //! Query
112   //! Returns true if the common block contains
113   //! a pave block that belongs
114   //! to the face with index <theIx>
115   Standard_EXPORT Standard_Boolean IsPaveBlockOnFace (const Standard_Integer theIndex) const;
116   
117
118   //! Query
119   //! Returns true if the common block contains
120   //! a pave block that belongs
121   //! to the edge with index <theIx>
122   Standard_EXPORT Standard_Boolean IsPaveBlockOnEdge (const Standard_Integer theIndex) const;
123   
124
125   //! Query
126   //! Returns true if the common block contains
127   //! a pave block that is equal  to <thePB>
128   Standard_EXPORT Standard_Boolean Contains (const Handle(BOPDS_PaveBlock)& thePB) const;
129   
130
131   //! Query
132   //! Returns true if the common block contains
133   //! the face with index equal  to <theF>
134   Standard_EXPORT Standard_Boolean Contains (const Standard_Integer theF) const;
135   
136
137   //! Modifier
138   //! Assign the index <theEdge> as the edge index
139   //! to all pave blocks of the common block
140   Standard_EXPORT void SetEdge (const Standard_Integer theEdge);
141   
142
143   //! Selector
144   //! Returns the index of the edge
145   //! of  all pave blocks of the common block
146   Standard_EXPORT Standard_Integer Edge() const;
147   
148   Standard_EXPORT void Dump() const;
149
150
151
152
153   DEFINE_STANDARD_RTTIEXT(BOPDS_CommonBlock,MMgt_TShared)
154
155 protected:
156
157
158   BOPDS_ListOfPaveBlock myPaveBlocks;
159   BOPCol_ListOfInteger myFaces;
160
161
162 private:
163
164
165
166
167 };
168
169
170
171
172
173
174
175 #endif // _BOPDS_CommonBlock_HeaderFile