src/IGESSelect/IGESSelect_SelectBypassSubfigure.cdl

   1 -- Created on: 1998-01-13
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1998-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 SelectBypassSubfigure  from IGESSelect  inherits SelectExplore
  18
  19     ---Purpose : Selects a list built as follows :
  20     --           Subfigures correspond to
  21     --           * Definition (basic : type 308, or Network : type 320)
  22     --           * Instance (Singular : type 408, or Network : 420, or
  23     --             patterns : 412,414)
  24     --
  25     --           Entities which are not Subfigure are taken as such
  26     --           For Subfigures Instances, their definition is taken, then
  27     --           explored itself
  28     --           For Subfigures Definitions, the list of "Associated Entities"
  29     --           is explored
  30     --           Hence, level 0 (D) recursively explores a Subfigure if some of
  31     --           its Elements are Subfigures. level 1 explores just at first
  32     --           level (i.e. for an instance, returns its definition)
  33
  34 uses AsciiString from TCollection, Transient, EntityIterator, Graph
  35
  36 raises InterfaceError
  37
  38 is
  39
  40     Create (level : Integer = 0) returns SelectBypassSubfigure;
  41     ---Purpose : Creates a SelectBypassSubfigure, by default all level
  42     --           (level = 1 explores at first level)
  43
  44     Explore (me; level : Integer; ent : Transient; G : Graph;
  45              explored : in out EntityIterator)
  46         returns Boolean;
  47     ---Purpose : Explores an entity : for a Subfigure, gives its elements
  48     --           Else, takes the entity itself
  49
  50
  51     ExploreLabel (me) returns AsciiString from TCollection;
  52     ---Purpose : Returns a text defining the criterium : "Content of Subfigure"
  53
  54 end SelectBypassSubfigure;