0024624: Lost word in license statement in source files
[occt.git] / src / BOPDS / BOPDS_FaceInfo.cdl
CommitLineData
4e57c75e 1-- Created by: Peter KURNEV
973c2be1 2-- Copyright (c) 2010-2014 OPEN CASCADE SAS
4e57c75e 3-- Copyright (c) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
4-- Copyright (c) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT,
5-- EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6--
973c2be1 7-- This file is part of Open CASCADE Technology software library.
4e57c75e 8--
d5f74e42 9-- This library is free software; you can redistribute it and/or modify it under
10-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 11-- by the Free Software Foundation, with special exception defined in the file
12-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
13-- distribution for complete text of the license and disclaimer of any warranty.
4e57c75e 14--
973c2be1 15-- Alternatively, this file may be used under the terms of Open CASCADE
16-- commercial license or contractual agreement.
4e57c75e 17
18class FaceInfo from BOPDS
19
20 ---Purpose:
21 -- The class BOPDS_FaceInfo is to store
22 -- handy information about state of face
23uses
24 BaseAllocator from BOPCol,
25 MapOfInteger from BOPCol,
26 IndexedMapOfPaveBlock from BOPDS
27
28--raises
29
30is
31 Create
32 returns FaceInfo from BOPDS;
33 ---C++: inline
34 ---C++: alias "virtual ~BOPDS_FaceInfo();"
35 ---Purpose:
36 --- Empty contructor
37 ---
38
39 Create (theAllocator: BaseAllocator from BOPCol)
40 returns FaceInfo from BOPDS;
41 ---C++: inline
42 ---Purpose:
43 --- Contructor
44 --- theAllocator - the allocator to manage the memory
45 ---
46
47 Clear(me:out);
48 ---Purpose:
49 --- Clears the contents
50
51 SetIndex(me:out;
52 theI: Integer from Standard);
53 ---C++: inline
54 ---Purpose:
55 --- Modifier
56 --- Sets the index of the face <theI>
57
58 Index(me)
59 returns Integer from Standard;
60 ---C++: inline
61 ---Purpose:
62 --- Selector
63 --- Returns the index of the face
64 --
65 -- In
66 --
67 PaveBlocksIn(me)
68 returns IndexedMapOfPaveBlock from BOPDS;
69 ---C++: return const &
70 ---C++: inline
71 ---Purpose:
72 --- Selector
73 --- Returns the pave blocks of the face
74 --- that have state In
75
76 ChangePaveBlocksIn(me:out)
77 returns IndexedMapOfPaveBlock from BOPDS;
78 ---C++: return &
79 ---C++: inline
80 ---Purpose:
81 --- Selector/Modifier
82 --- Returns the pave blocks
83 -- of the face
84 --- that have state In
85
86 VerticesIn(me)
87 returns MapOfInteger from BOPCol;
88 ---C++: return const &
89 ---C++: inline
90 ---Purpose:
91 --- Selector
92 --- Returns the list of indices for vertices
93 -- of the face
94 --- that have state In
95
96 ChangeVerticesIn(me:out)
97 returns MapOfInteger from BOPCol;
98 ---C++: return &
99 ---C++: inline
100 ---Purpose:
101 --- Selector/Modifier
102 --- Returns the list of indices for vertices
103 -- of the face
104 --- that have state In
105 --
106 -- On
107 --
108 PaveBlocksOn(me)
109 returns IndexedMapOfPaveBlock from BOPDS;
110 ---C++: return const &
111 ---C++: inline
112 ---Purpose:
113 --- Selector
114 --- Returns the pave blocks of the face
115 --- that have state On
116
117 ChangePaveBlocksOn(me:out)
118 returns IndexedMapOfPaveBlock from BOPDS;
119 ---C++: return &
120 ---C++: inline
121 ---Purpose:
122 --- Selector/Modifier
123 --- Returns the pave blocks
124 -- of the face
125 --- that have state On
126 VerticesOn(me)
127 returns MapOfInteger from BOPCol;
128 ---C++: return const &
129 ---C++: inline
130 ---Purpose:
131 --- Selector
132 --- Returns the list of indices for vertices
133 -- of the face
134 --- that have state On
135
136 ChangeVerticesOn(me:out)
137 returns MapOfInteger from BOPCol;
138 ---C++: return &
139 ---C++: inline
140 ---Purpose:
141 --- Selector/Modifier
142 --- Returns the list of indices for vertices
143 -- of the face
144 --- that have state On
145 --
146 -- Sections
147 --
148 PaveBlocksSc(me)
149 returns IndexedMapOfPaveBlock from BOPDS;
150 ---C++: return const &
151 ---C++: inline
152 ---Purpose:
153 --- Selector
154 --- Returns the pave blocks of the face
155 --- that are pave blocks of section edges
156
157 ChangePaveBlocksSc(me:out)
158 returns IndexedMapOfPaveBlock from BOPDS;
159 ---C++: return &
160 ---C++: inline
161 --- Selector/Modifier
162 --- Returns the pave blocks of the face
163 --- that are pave blocks of section edges
164
165 VerticesSc(me)
166 returns MapOfInteger from BOPCol;
167 ---C++: return const &
168 ---C++: inline
169 ---Purpose:
170 --- Selector
171 --- Returns the list of indices for section vertices
172 -- of the face
173
174 ChangeVerticesSc(me:out)
175 returns MapOfInteger from BOPCol;
176 ---C++: return &
177 ---C++: inline
178 ---Purpose:
179 --- Selector/Modifier
180 --- Returns the list of indices for section vertices
181 -- of the face
182 --
183 -- Others
184 --
185 --Update(me:out)
186 -- is protected;
187
188fields
189 myAllocator : BaseAllocator from BOPCol is protected;
190 myIndex : Integer from Standard is protected;
191 myPaveBlocksIn: IndexedMapOfPaveBlock from BOPDS is protected;
192 myVerticesIn : MapOfInteger from BOPCol is protected;
193 myPaveBlocksOn: IndexedMapOfPaveBlock from BOPDS is protected;
194 myVerticesOn : MapOfInteger from BOPCol is protected;
195 myPaveBlocksSc: IndexedMapOfPaveBlock from BOPDS is protected;
196 myVerticesSc : MapOfInteger from BOPCol is protected;
197
198end FaceInfo;