src/IFSelect/IFSelect_SelectEntityNumber.cdl

   1 -- Created on: 1992-11-18
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1992-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class SelectEntityNumber  from IFSelect  inherits SelectBase
  18
  19     ---Purpose : A SelectEntityNumber gets in an InterfaceModel (through a
  20     --           Graph), the Entity which has a specified Number (its rank of
  21     --           adding into the Model) : there can be zero (if none) or one.
  22     --           The Number is not directly defined as an Integer, but as a
  23     --           Parameter, which can be externally controled
  24
  25 uses AsciiString from TCollection, EntityIterator, Graph, IntParam
  26
  27 is
  28
  29     Create  returns mutable SelectEntityNumber;
  30     ---Purpose : Creates a SelectEntityNumber, initially with no specified Number
  31
  32     SetNumber (me : mutable; num : mutable IntParam);
  33     ---Purpose : Sets Entity Number to be taken (initially, none is set : 0)
  34
  35     Number (me) returns mutable IntParam;
  36     ---Purpose : Returns specified Number (as a Parameter)
  37
  38     RootResult (me; G : Graph) returns EntityIterator;
  39     ---Purpose : Returns the list of selected entities : the Entity having the
  40     --           specified Number (this result assures naturally uniqueness)
  41
  42     Label (me) returns AsciiString from TCollection;
  43     ---Purpose : Returns a text defining the criterium : "Entity Number ..."
  44
  45 fields
  46
  47     thenum : IntParam;
  48
  49 end SelectEntityNumber;