0024428: Implementation of LGPL license
[occt.git] / src / BOPDS / BOPDS_IndexRange.cdl
CommitLineData
4e57c75e 1-- Created by: Peter KURNEV
973c2be1 2-- Copyright (c) 1999-2014 OPEN CASCADE SAS
4e57c75e 3--
973c2be1 4-- This file is part of Open CASCADE Technology software library.
4e57c75e 5--
973c2be1 6-- This library is free software; you can redistribute it and / or modify it
7-- under the terms of the GNU Lesser General Public 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.
4e57c75e 11--
973c2be1 12-- Alternatively, this file may be used under the terms of Open CASCADE
13-- commercial license or contractual agreement.
4e57c75e 14
15class IndexRange from BOPDS
16
17 ---Purpose:
18 -- The class BOPDS_IndexRange is to store
19 -- the information about range of two indices
20--uses
21--raises
22
23is
24 Create
25 returns IndexRange from BOPDS;
26 ---C++: alias "Standard_EXPORT virtual ~BOPDS_IndexRange();"
27 ---C++: inline
28 ---Purpose:
29 --- Empty contructor
30 ---
31
32 SetFirst(me:out;
33 theI1:Integer from Standard);
34 ---C++: inline
35 ---Purpose:
36 --- Modifier
37 --- Sets the first index <theI1> of the range
38
39 SetLast(me:out;
40 theI2:Integer from Standard);
41 ---C++: inline
42 ---Purpose:
43 --- Modifier
44 --- Sets the second index <theI2> of the range
45
46 First(me)
47 returns Integer from Standard;
48 ---C++: inline
49 ---Purpose:
50 --- Selector
51 --- Returns the first index of the range
52
53 Last(me)
54 returns Integer from Standard;
55 ---C++: inline
56 ---Purpose:
57 --- Selector
58 --- Returns the second index of the range
59
60 SetIndices(me:out;
61 theI1:Integer from Standard;
62 theI2:Integer from Standard);
63 ---C++: inline
64 ---Purpose:
65 --- Modifier
66 --- Sets the first index of the range <theI1>
67 --- Sets the second index of the range <theI2>
68
69 Indices(me;
70 theI1:out Integer from Standard;
71 theI2:out Integer from Standard);
72 ---C++: inline
73 ---Purpose:
74 --- Selector
75 --- Returns the first index of the range <theI1>
76 --- Returns the second index of the range <theI2>
77
78 Contains(me;
79 theIndex:Integer from Standard)
80 returns Boolean from Standard;
81 ---C++: inline
82 ---Purpose:
83 --- Query
84 --- Returns true if the range contains <theIndex>
85
86 Dump(me);
87
88
89
90fields
91 myFirst : Integer from Standard is protected;
92 myLast : Integer from Standard is protected;
93
94end IndexRange;