src/IFSelect/IFSelect_SelectCombine.cdl

   1 -- Created on: 1992-11-17
   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
  21
  22
  23 deferred class SelectCombine  from IFSelect  inherits Selection
  24
  25     ---Purpose : A SelectCombine type Selection defines algebraic operations
  26     --           between results of several Selections
  27     --           It is a deferred class : sub-classes will have to define
  28     --           precise what operator is to be applied
  29
  30 uses AsciiString from TCollection, EntityIterator,
  31      Graph, SelectionIterator, TSeqOfSelection
  32
  33 is
  34
  35     Initialize;
  36     ---Purpose : Defines an empty SelectCombine
  37
  38     NbInputs (me) returns Integer;
  39     ---Purpose : Returns the count of Input Selections
  40
  41     Input (me; num : Integer) returns mutable Selection;
  42     ---Purpose : Returns an Input Selection, given its rank in the list
  43
  44     InputRank (me; sel : Selection) returns Integer;
  45     ---Purpose : Returns the rank of an input Selection, 0 if not in the list.
  46     --           Most generally, its value is meaningless, except for testing
  47     --           the presence of an input Selection :
  48     --           - == 0  if <sel> is not an input for <me>
  49     --           - >  0  if <sel> is an input for <me>
  50
  51     Add (me : mutable; sel : mutable Selection; atnum : Integer = 0);
  52     ---Purpose : Adds a Selection to the filling list
  53     --           By default, adds it to the end of the list
  54     --           A Positive rank less then NbInputs gives an insertion rank
  55     --           (InsertBefore : the new <atnum>th item of the list is <sel>)
  56
  57     Remove (me : mutable; sel : Selection) returns Boolean;
  58     ---Purpose : Removes an input Selection.
  59     --           Returns True if Done, False, if <sel> is not an input for <me>
  60
  61     Remove (me : mutable; num : Integer) returns Boolean;
  62     ---Purpose : Removes an input Selection, given its rank in the list
  63     --           Returns True if Done, False if <num> is out of range
  64
  65
  66     HasUniqueResult (me) returns Boolean  is redefined protected;
  67     ---Purpose : Returns always True, because RootResult gives a Unique list
  68
  69
  70     FillIterator (me; iter : in out SelectionIterator);
  71     ---Purpose : Puts in an Iterator the Selections from which "me" depends
  72     --           That is to say, the list of Input Selections
  73
  74 fields
  75
  76     thelist : TSeqOfSelection;
  77
  78 end SelectCombine;