include/opencascade/IFGraph_Cumulate.hxx

0001 // Created on: 1992-09-23
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-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 _IFGraph_Cumulate_HeaderFile
0018 #define _IFGraph_Cumulate_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Interface_Graph.hxx>
0025 #include <Interface_GraphContent.hxx>
0026 #include <Standard_Integer.hxx>
0027 class Standard_Transient;
0028 class Interface_EntityIterator;
0029
0030
0031 //! this class evaluates effect of cumulated sub-parts :
0032 //! overlapping, forgotten entities
0033 //! Results are kept in a Graph, several question can be set
0034 //! Basic Iteration gives entities which are part of Cumulation
0035 class IFGraph_Cumulate  : public Interface_GraphContent
0036 {
0037 public:
0038
0039   DEFINE_STANDARD_ALLOC
0040
0041
0042   //! creates empty Cumulate, ready to work
0043   Standard_EXPORT IFGraph_Cumulate(const Interface_Graph& agraph);
0044
0045   //! adds an entity and its shared ones to the list
0046   Standard_EXPORT void GetFromEntity (const Handle(Standard_Transient)& ent);
0047
0048   //! adds a list of entities (as an iterator) as such, that is,
0049   //! without their shared entities (use AllShared to have them)
0050   Standard_EXPORT void GetFromIter (const Interface_EntityIterator& iter);
0051
0052   //! Allows to restart on a new data set
0053   Standard_EXPORT void ResetData();
0054
0055   //! Evaluates the result of cumulation
0056   Standard_EXPORT virtual void Evaluate() Standard_OVERRIDE;
0057
0058   //! returns entities which are taken several times
0059   Standard_EXPORT Interface_EntityIterator Overlapped() const;
0060
0061   //! returns entities which are not taken
0062   Standard_EXPORT Interface_EntityIterator Forgotten() const;
0063
0064   //! Returns entities taken a given count of times
0065   //! (0 : same as Forgotten, 1 : same as no Overlap : default)
0066   Standard_EXPORT Interface_EntityIterator PerCount (const Standard_Integer count = 1) const;
0067
0068   //! returns number of times an Entity has been counted
0069   //! (0 means forgotten, more than 1 means overlap, 1 is normal)
0070   Standard_EXPORT Standard_Integer NbTimes (const Handle(Standard_Transient)& ent) const;
0071
0072   //! Returns the highest number of times recorded for every Entity
0073   //! (0 means empty, 1 means no overlap)
0074   Standard_EXPORT Standard_Integer HighestNbTimes() const;
0075
0076
0077
0078
0079 protected:
0080
0081
0082
0083
0084
0085 private:
0086
0087
0088
0089   Interface_Graph thegraph;
0090
0091
0092 };
0093
0094
0095
0096
0097
0098
0099
0100 #endif // _IFGraph_Cumulate_HeaderFile