0024157: Parallelization of assembly part of BO
[occt.git] / src / IFSelect / IFSelect_SelectRange.cdl
CommitLineData
b311480e 1-- Created on: 1992-11-18
2-- Created by: Christian CAILLET
3-- Copyright (c) 1992-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22
23class SelectRange from IFSelect inherits SelectExtract
24
25 ---Purpose : A SelectRange keeps or rejects a sub-set of the input set,
26 -- that is the Entities of which rank in the iteration list
27 -- is in a given range (for instance form 2nd to 6th, etc...)
28
29uses AsciiString from TCollection, InterfaceModel, IntParam
30
31raises DomainError
32
33is
34
35 Create returns mutable SelectRange;
36 ---Purpose : Creates a SelectRange. Default is Take all the input list
37
38 SetRange (me : mutable; rankfrom, rankto : mutable IntParam)
39 raises DomainError;
40 ---Purpose : Sets a Range for numbers, with a lower and a upper limits
41 -- Error if rankto is lower then rankfrom
42
43 SetOne (me : mutable; rank : mutable IntParam);
44 ---Purpose : Sets a unique number (only one Entity will be sorted as True)
45
46 SetFrom (me : mutable; rankfrom : mutable IntParam);
47 ---Purpose : Sets a Lower limit but no upper limit
48
49 SetUntil (me : mutable; rankto : mutable IntParam);
50 ---Purpose : Sets an Upper limit but no lower limit (equivalent to lower 1)
51
52 HasLower (me) returns Boolean;
53 ---Purpose : Returns True if a Lower limit is defined
54
55 Lower (me) returns mutable IntParam;
56 ---Purpose : Returns Lower limit (if there is; else, value is senseless)
57
58 LowerValue (me) returns Integer;
59 ---Purpose : Returns Value of Lower Limit (0 if none is defined)
60
61 HasUpper (me) returns Boolean;
62 ---Purpose : Returns True if a Lower limit is defined
63
64 Upper (me) returns mutable IntParam;
65 ---Purpose : Returns Upper limit (if there is; else, value is senseless)
66
67 UpperValue (me) returns Integer;
68 ---Purpose : Returns Value of Upper Limit (0 if none is defined)
69
70
71 Sort (me; rank : Integer; ent : Transient; model : InterfaceModel)
72 returns Boolean;
73 ---Purpose : Returns True for an Entity of which occurence number in the
74 -- iteration is inside the selected Range (considers <rank>)
75
76 ExtractLabel (me) returns AsciiString from TCollection;
77 ---Purpose : Returns a text defining the criterium : following cases,
78 -- " From .. Until .." or "From .." or "Until .." or "Rank no .."
79
80fields
81
82 thelower : IntParam;
83 theupper : IntParam;
84
85end SelectRange;