0023024: Update headers of OCCT files
[occt.git] / src / BOPTColStd / BOPTColStd_ShapeWithRank.cdl
CommitLineData
b311480e 1-- Created on: 2001-06-08
2-- Created by: Peter KURNEV
3-- Copyright (c) 2001-2012 OPEN CASCADE SAS
4--
5-- The content of this file is subject to the Open CASCADE Technology Public
6-- License Version 6.5 (the "License"). You may not use the content of this file
7-- except in compliance with the License. Please obtain a copy of the License
8-- at http://www.opencascade.org and read it completely before using this file.
9--
10-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12--
13-- The Original Code and all software distributed under the License is
14-- distributed on an "AS IS" basis, without warranty of any kind, and the
15-- Initial Developer hereby disclaims all such warranties, including without
16-- limitation, any warranties of merchantability, fitness for a particular
17-- purpose or non-infringement. Please see the License for the specific terms
18-- and conditions governing the rights and limitations under the License.
19
7fd59977 20
21
22class ShapeWithRank from BOPTColStd
23
24 ---Purpose:
25 -- The auxiliary class provides structure to store a shape
26 -- and its rank
27 ---
28uses
29 Shape from TopoDS
30
31--raises
32
33is
34 Create
35 returns ShapeWithRank from BOPTColStd;
36 ---Purpose:
37 -- Empty constructor
38 ---
39 SetShape(me:out;
40 aS: Shape from TopoDS);
41 ---Purpose:
42 -- Modifier
43 ---
44 SetRank(me:out;
45 aR: Integer from Standard);
46 ---Purpose:
47 -- Modifier
48 ---
49 Shape(me)
50 returns Shape from TopoDS;
51 ---C++: return const &
52 ---Purpose:
53 -- Selector
54 ---
55 Rank(me)
56 returns Integer from Standard;
57 ---Purpose:
58 -- Selector
59 ---
60 HashCode(me;
61 Upper:Integer from Standard)
62 returns Integer from Standard;
63 ---Purpose: Returns a HasCode value for the Key <K> in the
64 -- range 0..Upper.
65 --
66 IsEqual(me;
67 Other:ShapeWithRank from BOPTColStd)
68 returns Boolean from Standard;
69 ---Purpose: Returns True when the two keys are the same. Two
70 -- same keys must have the same hashcode, the
71 -- contrary is not necessary.
72 --
73
74fields
75 myShape : Shape from TopoDS;
76 myRank : Integer from Standard;
77
78end ShapeWithRank;