src/IFSelect/IFSelect_CheckCounter.cdl

   1 -- Created on: 1994-11-07
   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 CheckCounter  from IFSelect  inherits SignatureList
  18
  19     ---Purpose : A CheckCounter allows to see a CheckList (i.e. CheckIterator)
  20     --           not per entity, its messages, but per message, the entities
  21     --           attached (count and list). Because many messages can be
  22     --           repeated if they are due to systematic errors
  23
  24 uses CheckIterator, InterfaceModel, SignText from MoniTool
  25
  26 is
  27
  28     Create (withlist : Boolean = Standard_False) returns CheckCounter;
  29     ---Purpose : Creates a CheckCounter, empty ready to work
  30
  31     SetSignature (me : mutable; sign : SignText);
  32     ---Purpose : Sets a specific signature
  33     --           Else, the current SignType (in the model) is used
  34
  35     Signature    (me) returns SignText;
  36     ---Purpose : Returns the Signature;
  37
  38     Analyse (me : mutable;
  39          list  : CheckIterator;
  40          model : InterfaceModel;
  41          original  : Boolean = Standard_False;
  42          failsonly : Boolean = Standard_False);
  43     ---Purpose : Analyses a CheckIterator according a Model (which detains the
  44     --           entities for which the CheckIterator has messages), i.e.
  45     --           counts messages for entities
  46     --           If <original> is True, does not consider final messages but
  47     --             those before interpretation (such as inserting variables :
  48     --             integers, reals, strings)
  49     --           If <failsonly> is True, only Fails are considered
  50     --           Remark : global messages are recorded with a Null entity
  51
  52 fields
  53
  54     thesign : SignText;  -- optional
  55
  56 end CheckCounter;