src/IFSelect/IFSelect_Selection.cdl

   1 -- Created on: 1992-11-17
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1992-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 deferred class Selection  from IFSelect  inherits TShared
  24
  25     ---Purpose : A Selection allows to define a set of Interface Entities.
  26     --           Entities to be put on an output file should be identified in
  27     --           a way as independant from such or such execution as possible.
  28     --           This permits to handle comprehensive criteria, and to replay
  29     --           them when a new variant of an input file has to be processed.
  30     --
  31     --           Its input can be, either an Interface Model (the very source),
  32     --           or another-other Selection(s) or any other ouput. All list
  33     --           computations start from an input Graph (from IFGraph)
  34
  35 uses AsciiString from TCollection, EntityIterator, Graph, SelectionIterator
  36
  37 raises InterfaceError
  38
  39 is
  40
  41     RootResult (me; G : Graph) returns EntityIterator
  42         raises InterfaceError  is deferred;
  43     ---Purpose : Returns the list of selected entities, computed from Input
  44     --           given as a Graph. Specific to each class of Selection
  45     --           Note that uniqueness of each entity is not required here
  46     --           This method can raise an exception as necessary
  47
  48     HasUniqueResult (me) returns Boolean  is virtual protected;
  49     ---Purpose : Returns True if RootResult guarantees uniqueness for each
  50     --           Entity. Called by UniqueResult.
  51     --           Default answer is False. Can be redefined.
  52
  53     UniqueResult (me; G : Graph) returns EntityIterator;
  54     ---Purpose : Returns the list of selected entities, each of them beeing
  55     --           unique. Default definition works from RootResult. According
  56     --           HasUniqueResult, UniqueResult returns directly RootResult,
  57     --           or build a Unique Result from it with a Graph.
  58
  59     CompleteResult (me; G : Graph) returns EntityIterator  is virtual;
  60     ---Purpose : Returns the list of entities involved by a Selection, i.e.
  61     --           UniqueResult plus the shared entities (directly or not)
  62
  63
  64     FillIterator (me; iter : in out SelectionIterator)  is deferred;
  65     ---Purpose : Puts in an Iterator the Selections from which "me" depends
  66     --           (there can be zero, or one, or a list).
  67     --           Specific to each class of Selection
  68
  69     Label (me) returns AsciiString from TCollection  is deferred;
  70     ---Purpose : Returns a text which defines the criterium applied by a
  71     --           Selection (can be used to be printed, displayed ...)
  72     --           Specific to each class
  73
  74 end Selection;