0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BOPDS / BOPDS_Pave.cdl
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 class Pave from BOPDS  
16
17         ---Purpose: 
18         -- The class BOPDS_Pave is to store  
19         -- information about vertex on an edge 
20 --uses
21 --raises
22
23 is 
24     Create 
25         returns Pave from BOPDS; 
26     ---C++: alias "Standard_EXPORT virtual ~BOPDS_Pave();"   
27     ---C++: inline  
28         ---Purpose:  
29         --- Empty contructor  
30         ---  
31      
32     SetIndex(me:out;  
33             theIndex: Integer from Standard); 
34     ---C++: inline    
35         ---Purpose:   
36         --- Modifier   
37         --- Sets the index of vertex <theIndex>
38         
39     Index(me)  
40         returns Integer from Standard; 
41     ---C++: inline  
42         ---Purpose: 
43         --- Selector   
44         --- Returns the index of vertex 
45     SetParameter(me:out;  
46             theParameter: Real from Standard); 
47     ---C++: inline      
48         ---Purpose:   
49         --- Modifier   
50         --- Sets the parameter of vertex <theParameter> 
51         
52     Parameter(me)  
53         returns Real from Standard; 
54     ---C++: inline      
55         ---Purpose: 
56         --- Selector   
57         --- Returns the parameter of vertex
58     Contents(me; 
59             theIndex:out Integer from Standard; 
60             theParameter:out Real from Standard); 
61     ---C++: inline 
62         ---Purpose: 
63         --- Selector  
64         --- Returns the index of vertex <theIndex>  
65         --- Returns the parameter of vertex <theParameter> 
66         
67     IsLess(me; 
68             theOther:  Pave from BOPDS) 
69         returns Boolean from Standard;  
70     ---C++: alias operator <     
71     ---C++: inline  
72         ---Purpose: 
73         --- Query  
74         --- Returns true if thr parameter od this is less   
75         --  than the parameter of  <theOther> 
76     
77     IsEqual(me; 
78             theOther:  Pave from BOPDS) 
79         returns Boolean from Standard;  
80     ---C++: alias operator == 
81     ---C++: inline  
82         ---Purpose: 
83         --- Query  
84         --- Returns true if thr parameter od this is equal   
85         --  to the parameter of  <theOther> 
86          
87     Dump(me); 
88
89 fields 
90     myIndex    : Integer from Standard is protected;     
91     myParameter: Real from Standard is protected;     
92
93 end Pave;