src/IFSelect/IFSelect_SelectFlag.cdl

   1 -- Created on: 1995-09-05
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1995-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 SelectFlag  from IFSelect  inherits SelectExtract
  24
  25     ---Purpose : A SelectFlag queries a flag noted in the bitmap of the Graph.
  26     --           The Flag is designated by its Name. Flag Names are defined
  27     --           by Work Session and, as necessary, other functional objects
  28     --
  29     --           WorkSession from IFSelect defines flag "Incorrect"
  30     --           Objects which control application running define some others
  31
  32 uses AsciiString from TCollection, InterfaceModel, Graph, EntityIterator
  33
  34 is
  35
  36     Create (flagname : CString) returns mutable SelectFlag;
  37     ---Purpose : Creates a Select Flag, to query a flag designated by its name
  38
  39     FlagName (me) returns CString;
  40     ---Purpose : Returns the name of the flag
  41
  42     RootResult (me; G : Graph) returns EntityIterator  is redefined;
  43     ---Purpose : Returns the list of selected entities. It is redefined to
  44     --           work on the graph itself (not queried by sort)
  45     --
  46     --           An entity is selected if its flag is True on Direct mode,
  47     --           False on Reversed mode
  48     --
  49     --           If flag does not exist for the given name, returns an empty
  50     --           result, whatever the Direct/Reversed sense
  51
  52     Sort (me; rank : Integer; ent : Transient; model : InterfaceModel)
  53         returns Boolean;
  54     ---Purpose : Returns always False because RootResult has done the work
  55
  56
  57     ExtractLabel (me) returns AsciiString from TCollection;
  58     ---Purpose : Returns a text defining the criterium, includes the flag name
  59
  60 fields
  61
  62     thename : AsciiString from TCollection;
  63
  64 end SelectFlag;