src/IFSelect/IFSelect_GraphCounter.cdl

   1 -- Created on: 1998-10-15
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1998-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 GraphCounter  from IFSelect    inherits SignCounter  from IFSelect
  24
  25     ---Purpose : A GraphCounter computes values to be sorted with the help of
  26     --           a Graph. I.E. not from a Signature
  27     --
  28     --           The default GraphCounter works with an Applied Selection (a
  29     --           SelectDeduct), the value is the count of selected entities
  30     --           from each input entities)
  31
  32 uses HSequenceOfTransient from TColStd,
  33      Graph from Interface, SelectDeduct from IFSelect
  34
  35 is
  36
  37     Create (withmap  : Boolean = Standard_True;
  38             withlist : Boolean = Standard_False) returns mutable GraphCounter;
  39     ---Purpose : Creates a GraphCounter, without applied selection
  40
  41     Applied (me) returns SelectDeduct;
  42     ---Purpose : Returns the applied selection
  43
  44     SetApplied (me : mutable; sel : SelectDeduct);
  45     ---Purpose : Sets a new applied selection
  46
  47     AddWithGraph (me : mutable; list : HSequenceOfTransient; graph : Graph)
  48         is redefined virtual;
  49     ---Purpose : Adds a list of entities in the context given by the graph
  50     --           Default takes the count of entities selected by the applied
  51     --           selection, when it is given each entity of the list
  52     --           Can be redefined
  53
  54 fields
  55
  56     theapplied : SelectDeduct;
  57
  58 end GraphCounter;