Files
OCCT/src/IFSelect/IFSelect_SelectAnyList.cdl
abv 6e33d3ced2 0024830: Remove redundant keyword 'mutable' in CDL declarations
Redundant keyword 'mutable' removed in CDL files.
In IGESConvGeom_GeomBuilder, unused methods MakeXY() and MakeXYZ() removed.
Method StepAP214_AutoDesignGroupAssignment::Init() replicating same method of the base class is removed as it causes CDL extraction error after above (seemingly irrelevant) changes.
2014-05-29 14:58:25 +04:00

124 lines
5.4 KiB
Plaintext

-- Created on: 1992-12-09
-- Created by: Christian CAILLET
-- Copyright (c) 1992-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
deferred class SelectAnyList from IFSelect inherits SelectDeduct
---Purpose : A SelectAnyList kind Selection selects a List of an Entity, as
-- well as this Entity contains some. A List contains sub-entities
-- as one per Item, or several (for instance if an Entity binds
-- couples of sub-entities, each item is one of these couples).
-- Remark that only Entities are taken into account (neither
-- Reals, nor Strings, etc...)
--
-- To define the list on which to work, SelectAnyList has two
-- deferred methods : NbItems (which gives the length of the
-- list), FillResult (which fills an EntityIterator). They are
-- intended to get a List in an Entity of the required Type (and
-- consider that list is empty if Entity has not required Type)
--
-- In addition, remark that some types of Entity define more than
-- one list in each instance : a given sub-class of SelectAnyList
-- must be attached to one list
--
-- SelectAnyList keeps or rejects a sub-set of the list,
-- that is the Items of which rank in the list is in a given
-- range (for instance form 2nd to 6th, etc...)
-- Range is defined by two Integer values. In order to allow
-- external control of them, these values are not directly
-- defined as fields, but accessed through IntParams, that is,
-- referenced as Transient (Handle) objects
--
-- Warning : the Input can be any kind of Selection, BUT its
-- RootResult must have zero (empty) or one Entity maximum
uses AsciiString from TCollection, Transient, EntityIterator, Graph, IntParam
raises OutOfRange, InterfaceError
is
KeepInputEntity (me; iter : in out EntityIterator) is deferred;
---Purpose : Keeps Input Entity, as having required type. It works by
-- keeping in <iter>, only suitable Entities (SelectType can be
-- used). Called by RootResult (which waits for ONE ENTITY MAX)
NbItems (me; ent : Transient) returns Integer is deferred;
---Purpose : Returns count of Items in the list in the Entity <ent>
-- If <ent> has not required type, returned value must be Zero
SetRange (me : mutable; rankfrom, rankto : IntParam);
---Purpose : Sets a Range for numbers, with a lower and a upper limits
SetOne (me : mutable; rank : IntParam);
---Purpose : Sets a unique number (only one Entity will be sorted as True)
SetFrom (me : mutable; rankfrom : IntParam);
---Purpose : Sets a Lower limit but no upper limit
SetUntil (me : mutable; rankto : IntParam);
---Purpose : Sets an Upper limit but no lower limit (equivalent to lower 1)
HasLower (me) returns Boolean;
---Purpose : Returns True if a Lower limit is defined
Lower (me) returns IntParam;
---Purpose : Returns Lower limit (if there is; else, value is senseless)
LowerValue (me) returns Integer;
---Purpose : Returns Integer Value of Lower Limit (0 if none)
HasUpper (me) returns Boolean;
---Purpose : Returns True if a Lower limit is defined
Upper (me) returns IntParam;
---Purpose : Returns Upper limit (if there is; else, value is senseless)
UpperValue (me) returns Integer;
---Purpose : Returns Integer Value of Upper Limit (0 if none)
RootResult (me; G : Graph) returns EntityIterator raises InterfaceError;
---Purpose : Returns the list of selected entities (list of entities
-- complying with rank criterium)
-- Error if the input list has more than one Item
FillResult (me; n1,n2 : Integer; ent : Transient;
res : in out EntityIterator) is deferred;
---Purpose : Puts into <res>, the sub-entities of the list, from n1 to
-- n2 included. Remark that adequation with Entity's type and
-- length of list has already been made at this stage
-- Called by RootResult
Label (me) returns AsciiString from TCollection;
---Purpose : Returns a text defining the criterium : "Componants of List "
-- then Specific List Label, then, following cases :
-- " From .. Until .." or "From .." or "Until .." or "Rank no .."
-- Specific type is given by deferred method ListLabel
ListLabel (me) returns AsciiString from TCollection is deferred;
---Purpose : Returns the specific label for the list, which is included as
-- a part of Label
fields
thelower : IntParam;
theupper : IntParam;
end SelectAnyList;