src/IFSelect/IFSelect_CheckCounter.hxx

   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 #ifndef _IFSelect_CheckCounter_HeaderFile
  18 #define _IFSelect_CheckCounter_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <IFSelect_SignatureList.hxx>
  24 #include <Standard_Boolean.hxx>
  25 class MoniTool_SignText;
  26 class Interface_CheckIterator;
  27 class Interface_InterfaceModel;
  28
  29
  30 class IFSelect_CheckCounter;
  31 DEFINE_STANDARD_HANDLE(IFSelect_CheckCounter, IFSelect_SignatureList)
  32
  33 //! A CheckCounter allows to see a CheckList (i.e. CheckIterator)
  34 //! not per entity, its messages, but per message, the entities
  35 //! attached (count and list). Because many messages can be
  36 //! repeated if they are due to systematic errors
  37 class IFSelect_CheckCounter : public IFSelect_SignatureList
  38 {
  39
  40 public:
  41
  42
  43   //! Creates a CheckCounter, empty ready to work
  44   Standard_EXPORT IFSelect_CheckCounter(const Standard_Boolean withlist = Standard_False);
  45
  46   //! Sets a specific signature
  47   //! Else, the current SignType (in the model) is used
  48   Standard_EXPORT void SetSignature (const Handle(MoniTool_SignText)& sign);
  49
  50   //! Returns the Signature;
  51   Standard_EXPORT Handle(MoniTool_SignText) Signature() const;
  52
  53   //! Analyses a CheckIterator according a Model (which detains the
  54   //! entities for which the CheckIterator has messages), i.e.
  55   //! counts messages for entities
  56   //! If <original> is True, does not consider final messages but
  57   //! those before interpretation (such as inserting variables :
  58   //! integers, reals, strings)
  59   //! If <failsonly> is True, only Fails are considered
  60   //! Remark : global messages are recorded with a Null entity
  61   Standard_EXPORT void Analyse (const Interface_CheckIterator& list, const Handle(Interface_InterfaceModel)& model, const Standard_Boolean original = Standard_False, const Standard_Boolean failsonly = Standard_False);
  62
  63
  64
  65
  66   DEFINE_STANDARD_RTTIEXT(IFSelect_CheckCounter,IFSelect_SignatureList)
  67
  68 protected:
  69
  70
  71
  72
  73 private:
  74
  75
  76   Handle(MoniTool_SignText) thesign;
  77
  78
  79 };
  80
  81
  82
  83
  84
  85
  86
  87 #endif // _IFSelect_CheckCounter_HeaderFile