src/IFSelect/IFSelect_SelectSignedShared.cdl

   1 -- Created on: 1996-09-25
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1996-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 class SelectSignedShared  from IFSelect  inherits SelectExplore
  24
  25     ---Purpose : In the graph, explore the Shareds of the input entities,
  26     --           until it encounters some which match a given Signature
  27     --           (for a limited level, filters the returned list)
  28     --           By default, fitted for any level
  29
  30 uses AsciiString, Transient,  Graph, EntityIterator, Signature
  31
  32 is
  33
  34     Create (matcher : Signature;
  35             signtext : CString;
  36             exact : Boolean = Standard_True;
  37             level : Integer = 0)  returns mutable SelectSignedShared;
  38     ---Purpose : Creates a SelectSignedShared, defaulted for any level
  39     --           with a given Signature and text to match
  40
  41     Signature (me) returns mutable Signature;
  42     ---Purpose : Returns the used Signature, then it is possible to access it,
  43     --           modify it as required
  44
  45     SignatureText (me) returns AsciiString from TCollection;
  46     ---Purpose : Returns Text used to Sort Entity on its Signature
  47     ---C++ : return const &
  48
  49     IsExact (me) returns Boolean;
  50     ---Purpose : Returns True if match must be exact
  51
  52     Explore (me; level : Integer; ent : Transient; G : Graph;
  53              explored : in out EntityIterator)
  54         returns Boolean;
  55     ---Purpose : Explores an entity : its Shared entities
  56     --           <ent> to take if it matches the Signature
  57     --           At level max, filters the result. Else gives all Shareds
  58
  59
  60     ExploreLabel (me) returns AsciiString from TCollection;
  61     ---Purpose : Returns a text defining the criterium.
  62     --           (it refers to the text and exact flag to be matched, and is
  63     --           qualified by the Name provided by the Signature)
  64
  65 fields
  66
  67     thematcher  : Signature;
  68     thesigntext : AsciiString from TCollection;
  69     theexact    : Boolean;
  70
  71 end SelectSignedShared;