0024750: Replace instantiations of TCollection generic classes by NCollection templat...
[occt.git] / src / IntTools / IntTools_Compare.cdl
1 -- Created on: 2000-05-22
2 -- Created by: Peter KURNEV
3 -- Copyright (c) 2000-2014 OPEN CASCADE SAS
4 --
5 -- This file is part of Open CASCADE Technology software library.
6 --
7 -- This library is free software; you can redistribute it and/or modify it under
8 -- the terms of the GNU Lesser General Public License version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
12 --
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
15
16 class Compare from IntTools 
17
18         ---Purpose: Auxiliary class to provide a sorting Roots.     
19
20 uses
21     Root from IntTools
22
23 is
24     Create   
25         returns Compare from IntTools;
26         ---Purpose:
27         --- Empty constructor
28         ---
29          
30     Create  (aTol:Real from Standard) 
31         returns Compare from IntTools;
32         ---Purpose:
33         --- Initializes me by tolerance
34         ---
35          
36     IsLower (me; Left, Right: Root from IntTools)
37         ---Purpose: 
38         --- Returns True if <Left> is lower than <Right>.
39         ---
40         returns Boolean from Standard;
41     
42     IsGreater (me; Left, Right: Root from IntTools)
43         ---Level: Public
44         ---Purpose: 
45         --- Returns True if <Left> is greater than <Right>.
46         ---
47         returns Boolean from Standard;
48
49     IsEqual(me; Left, Right: Root from IntTools)
50         ---Level: Public
51         ---Purpose: 
52         --- Returns True when <Right> and <Left> are equal.
53         ---
54         returns Boolean from Standard ;
55                 
56
57 fields
58     myTol: Real from Standard; 
59      
60 end Compare;