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