0024023: Revamp the OCCT Handle -- general
[occt.git] / src / IGESSelect / IGESSelect_SelectBypassGroup.cdl
1 -- Created on: 1994-06-01
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1994-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 SelectBypassGroup  from IGESSelect  inherits SelectExplore
18
19     ---Purpose : Selects a list built as follows :
20     --           Groups are entities type 402, forms 1,7,14,15 (Group,
21     --           Ordered or not, "WithoutBackPointer" or not)
22     --           
23     --           Entities which are not GROUP are taken as such
24     --           For Groups, their list of Elements is explore
25     --           Hence, level 0 (D) recursively explores a Group if some of
26     --           its Elements are Groups. level 1 explores just at first level
27
28 uses AsciiString from TCollection, Transient, EntityIterator, Graph
29
30 raises InterfaceError
31
32 is
33
34     Create (level : Integer = 0) returns SelectBypassGroup;
35     ---Purpose : Creates a SelectBypassGroup, by default all level
36     --           (level = 1 explores at first level)
37
38     Explore (me; level : Integer; ent : Transient; G : Graph;
39              explored : in out EntityIterator)
40         returns Boolean;
41     ---Purpose : Explores an entity : for a Group, gives its elements
42     --           Else, takes the entity itself
43
44
45     ExploreLabel (me) returns AsciiString from TCollection;
46     ---Purpose : Returns a text defining the criterium : "Content of Group"
47
48 end SelectBypassGroup;