include/opencascade/IFSelect_CheckCounter.hxx

0001 // Created on: 1994-11-07
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1994-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IFSelect_CheckCounter_HeaderFile
0018 #define _IFSelect_CheckCounter_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IFSelect_SignatureList.hxx>
0023 class MoniTool_SignText;
0024 class Interface_CheckIterator;
0025 class Interface_InterfaceModel;
0026
0027 //! A CheckCounter allows to see a CheckList (i.e. CheckIterator)
0028 //! not per entity, its messages, but per message, the entities
0029 //! attached (count and list). Because many messages can be
0030 //! repeated if they are due to systematic errors
0031 class IFSelect_CheckCounter : public IFSelect_SignatureList
0032 {
0033
0034 public:
0035   //! Creates a CheckCounter, empty ready to work
0036   Standard_EXPORT IFSelect_CheckCounter(const bool withlist = false);
0037
0038   //! Sets a specific signature
0039   //! Else, the current SignType (in the model) is used
0040   Standard_EXPORT void SetSignature(const occ::handle<MoniTool_SignText>& sign);
0041
0042   //! Returns the Signature;
0043   Standard_EXPORT occ::handle<MoniTool_SignText> Signature() const;
0044
0045   //! Analyses a CheckIterator according a Model (which detains the
0046   //! entities for which the CheckIterator has messages), i.e.
0047   //! counts messages for entities
0048   //! If <original> is True, does not consider final messages but
0049   //! those before interpretation (such as inserting variables :
0050   //! integers, reals, strings)
0051   //! If <failsonly> is True, only Fails are considered
0052   //! Remark : global messages are recorded with a Null entity
0053   Standard_EXPORT void Analyse(const Interface_CheckIterator&               list,
0054                                const occ::handle<Interface_InterfaceModel>& model,
0055                                const bool                                   original  = false,
0056                                const bool                                   failsonly = false);
0057
0058   DEFINE_STANDARD_RTTIEXT(IFSelect_CheckCounter, IFSelect_SignatureList)
0059
0060 private:
0061   occ::handle<MoniTool_SignText> thesign;
0062 };
0063
0064 #endif // _IFSelect_CheckCounter_HeaderFile