Salome HOME
Fix documentation problems (reported as doxygen warnings)
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_PassKeyMapHasher.cdl
1 --  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
2 --
3 --  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 --
6 --  This library is free software; you can redistribute it and/or
7 --  modify it under the terms of the GNU Lesser General Public
8 --  License as published by the Free Software Foundation; either
9 --  version 2.1 of the License.
10 --
11 --  This library is distributed in the hope that it will be useful,
12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 --  Lesser General Public License for more details.
15 --
16 --  You should have received a copy of the GNU Lesser General Public
17 --  License along with this library; if not, write to the Free Software
18 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 --
20 --  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 --
22 -- File:        GEOMAlgo_PassKeyMapHasher.cdl
23 -- Created:     
24 -- Author:      Peter KURNEV
25 --              <pkv@irinox>
26 --
27 class PassKeyMapHasher from GEOMAlgo 
28
29         ---Purpose: 
30
31 uses 
32     PassKey from GEOMAlgo 
33
34 --raises
35
36 is 
37     HashCode(myclass;  
38             aPKey : PassKey from GEOMAlgo;  
39             Upper : Integer from Standard)  
40         returns Integer from Standard;
41         
42         
43     IsEqual(myclass;  
44             aPKey1 : PassKey from GEOMAlgo;  
45             aPKey2 : PassKey from GEOMAlgo)  
46         returns Boolean from Standard;
47
48 end PassKeyMapHasher;