Salome HOME
Fix documentation problems (reported as doxygen warnings)
[modules/geom.git] / src / NMTDS / NMTDS_IndexRange.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:       NMTDS_IndexRange.cdl
23 --  Created:    Fri Nov 28 10:31:05 2003
24 --  Author:     Peter KURNEV
25 --
26 class IndexRange from NMTDS 
27
28         ---Purpose: 
29
30 --uses
31 --raises
32
33 is 
34     Create 
35         returns IndexRange from NMTDS; 
36          
37     SetFirst(me:out; 
38             aFirst:Integer from Standard);       
39          
40     SetLast(me:out; 
41             aLast:Integer from Standard);        
42      
43     First(me) 
44         returns Integer from Standard; 
45          
46     Last(me) 
47         returns Integer from Standard;                               
48
49     IsInRange(me; 
50             aIndex:Integer from Standard) 
51         returns Boolean from Standard; 
52
53 fields 
54     myFirst  :  Integer from Standard is protected;  
55     myLast   :  Integer from Standard is protected;  
56
57 end IndexRange;